
Puppeteer
MCP Puppeteer Server HomeAssistant Add-on
what is Puppeteer?
Puppeteer is a Model Context Protocol server that provides browser automation capabilities using Puppeteer. It enables LLMs to interact with web pages, take screenshots, and execute JavaScript in a real browser environment.
how to use Puppeteer?
To use Puppeteer, configure it via Docker or NPX, and then utilize its various tools to navigate, take screenshots, click elements, and execute JavaScript in the browser.
key features of Puppeteer?
- Browser automation
- Console log monitoring
- Screenshot capabilities
- JavaScript execution
- Basic web interaction (navigation, clicking, form filling)
use cases of Puppeteer?
- Automating web testing and interactions.
- Taking screenshots of web pages for documentation.
- Executing JavaScript for data extraction from web pages.
FAQ from Puppeteer?
- Can Puppeteer automate any website?
Yes! Puppeteer can automate interactions with most websites, provided they are accessible.
- Is Puppeteer free to use?
Yes! Puppeteer is open-source and free to use under the MIT License.
- What are the system requirements for using Puppeteer?
Puppeteer requires a system that can run Docker or Node.js for NPX.
Puppeteer
A Model Context Protocol server that provides browser automation capabilities using Puppeteer. This server enables LLMs to interact with web pages, take screenshots, and execute JavaScript in a real browser environment.
Components
Tools
-
puppeteer_navigate
- Navigate to any URL in the browser
- Input:
url
(string)
-
puppeteer_screenshot
- Capture screenshots of the entire page or specific elements
- Inputs:
name
(string, required): Name for the screenshotselector
(string, optional): CSS selector for element to screenshotwidth
(number, optional, default: 800): Screenshot widthheight
(number, optional, default: 600): Screenshot height
-
puppeteer_click
- Click elements on the page
- Input:
selector
(string): CSS selector for element to click
-
puppeteer_hover
- Hover elements on the page
- Input:
selector
(string): CSS selector for element to hover
-
puppeteer_fill
- Fill out input fields
- Inputs:
selector
(string): CSS selector for input fieldvalue
(string): Value to fill
-
puppeteer_select
- Select an element with SELECT tag
- Inputs:
selector
(string): CSS selector for element to selectvalue
(string): Value to select
-
puppeteer_evaluate
- Execute JavaScript in the browser console
- Input:
script
(string): JavaScript code to execute
Resources
The server provides access to two types of resources:
-
Console Logs (
console://logs
)- Browser console output in text format
- Includes all console messages from the browser
-
Screenshots (
screenshot://<name>
)- PNG images of captured screenshots
- Accessible via the screenshot name specified during capture
Key Features
- Browser automation
- Console log monitoring
- Screenshot capabilities
- JavaScript execution
- Basic web interaction (navigation, clicking, form filling)
Configuration to use Puppeteer Server
Here's the Claude Desktop configuration to use the Puppeter server:
Docker
NOTE The docker implementation will use headless chromium, where as the NPX version will open a browser window.
{
"mcpServers": {
"puppeteer": {
"command": "docker",
"args": ["run", "-i", "--rm", "--init", "-e", "DOCKER_CONTAINER=true", "mcp/puppeteer"]
}
}
}
NPX
{
"mcpServers": {
"puppeteer": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-puppeteer"]
}
}
}
Build
Docker build:
docker build -t mcp/puppeteer -f src/puppeteer/Dockerfile .
License
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
