Puppeteer MCP server

This server provides browser automation capabilities using Puppeteer, enabling LLMs to interact with web pages, take screenshots, and execute JavaScript in a real browser environment. It offers a variety of tools for navigating, capturing screenshots, clicking elements, and more through the Model Context Protocol (MCP).

Installation Options

Docker Installation

The Docker implementation uses headless Chromium for browser automation:

{
  "mcpServers": {
    "puppeteer": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--init", "-e", "DOCKER_CONTAINER=true", "mcp/puppeteer"]
    }
  }
}

NPX Installation

The NPX version will open a visible browser window:

{
  "mcpServers": {
    "puppeteer": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
    }
  }
}

Available Tools

Navigation Tool

Navigate to any URL in the browser:

• Tool name: puppeteer_navigate
• Input: url (string)

Example:

{
  "tool": "puppeteer_navigate",
  "parameters": {
    "url": "https://example.com"
  }
}

Screenshot Tool

Capture screenshots of the entire page or specific elements:

• Tool name: puppeteer_screenshot
• Inputs:
  • name (string, required): Name for the screenshot
  • selector (string, optional): CSS selector for element to screenshot
  • width (number, optional, default: 800): Screenshot width
  • height (number, optional, default: 600): Screenshot height

Example:

{
  "tool": "puppeteer_screenshot",
  "parameters": {
    "name": "homepage",
    "width": 1024,
    "height": 768
  }
}

Click Tool

Click elements on the page:

• Tool name: puppeteer_click
• Input: selector (string): CSS selector for element to click

Example:

{
  "tool": "puppeteer_click",
  "parameters": {
    "selector": "#submit-button"
  }
}

Hover Tool

Hover over elements on the page:

• Tool name: puppeteer_hover
• Input: selector (string): CSS selector for element to hover

Example:

{
  "tool": "puppeteer_hover",
  "parameters": {
    "selector": ".dropdown-menu"
  }
}

Fill Tool

Fill out input fields:

• Tool name: puppeteer_fill
• Inputs:
  • selector (string): CSS selector for input field
  • value (string): Value to fill

Example:

{
  "tool": "puppeteer_fill",
  "parameters": {
    "selector": "#search-input",
    "value": "search query"
  }
}

Select Tool

Select an option in a dropdown menu:

• Tool name: puppeteer_select
• Inputs:
  • selector (string): CSS selector for select element
  • value (string): Value to select

Example:

{
  "tool": "puppeteer_select",
  "parameters": {
    "selector": "#country-select",
    "value": "US"
  }
}

JavaScript Evaluation Tool

Execute JavaScript in the browser console:

• Tool name: puppeteer_evaluate
• Input: script (string): JavaScript code to execute

Example:

{
  "tool": "puppeteer_evaluate",
  "parameters": {
    "script": "document.querySelectorAll('.item').length"
  }
}

Accessing Resources

The server provides access to two types of resources:

Console Logs

Access browser console output in text format:

• Resource URL: console://logs
• Includes all console messages from the browser

Example of accessing console logs:

GET console://logs

Screenshots

Access PNG images of captured screenshots:

• Resource URL: screenshot://<name>
• Where <name> is the name specified during capture

Example of accessing a screenshot:

GET screenshot://homepage

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.