Puppeteer

🚀 Puppeteer Server

A Model Context Protocol (MCP) server using Puppeteer, offering browser automation capabilities. This server enables LLMs to interact with web pages, take screenshots, and execute JavaScript in a real browser environment.

🚀 Quick Start

This Puppeteer server provides browser automation functions, allowing LLMs to interact with web pages, capture screenshots, and execute JavaScript in a real browser environment.

✨ Features

• Browser automation
• Console log monitoring
• Screenshot functionality
• JavaScript execution ability
• Basic web page interactions (navigation, clicking, form filling)

📦 Installation

Docker

Note: The Docker implementation uses headless Chromium, while the NPX version opens 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"]
    }
  }
}

📚 Documentation

Components

Tools

• puppeteer_navigate

  • Navigate the browser to any URL.
  • Input: url (string)

• puppeteer_screenshot

  • Take a screenshot of a web page or a specific element.
  • Input:
    • name (string, required): Screenshot name.
    • selector (string, optional): CSS selector for capturing a specific element.
    • width (number, optional, default: 800): Screenshot width.
    • height (number, optional, default: 600): Screenshot height.

• puppeteer_click

  • Click an element on the page.
  • Input: selector (string): CSS selector of the element to click.

• puppeteer_hover

  • Hover the mouse over an element on the page.
  • Input: selector (string): CSS selector of the element to hover over.

• puppeteer_fill

  • Fill a form field.
  • Input:
    • selector (string): CSS selector of the form field.
    • value (string): Value to fill.

• puppeteer_select

  • Select an element in a SELECT tag.
  • Input:
    • selector (string): CSS selector of the element to select.
    • value (string): Value to select.

• puppeteer_evaluate

  • Execute JavaScript code in the browser console.
  • Input: script (string): JavaScript code to execute.

Resources

The server provides the following two resources:

1. Console Logs (console://logs)

   • Text information output from the browser console.
   • Contains all console messages from the browser.

2. Screenshots (screenshot://<name>)

   • Screenshot images in PNG format.
   • Can be accessed via the screenshot name specified during capture.

🔧 Technical Details

Building

Docker build:

docker build -t mcp/puppeteer -f src/puppeteer/Dockerfile .

📄 License

This MCP server is licensed under the MIT License. This means you can use, modify, and distribute the software without restrictions, but you must comply with the terms and conditions of the MIT License. For more information, please refer to the LICENSE file in the project repository.