[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/phialsbasement-mcp-puppeteer-linux-badge.png)](https://mseep.ai/app/phialsbasement-mcp-puppeteer-linux)

# MCP-Puppeteer-Linux
[![smithery badge](https://smithery.ai/badge/@PhialsBasement/mcp-puppeteer-linux)](https://smithery.ai/server/@PhialsBasement/mcp-puppeteer-linux)
A Model Context Protocol server that provides browser automation capabilities using Puppeteer, with full support for Linux display servers (X11 and Wayland). This server enables LLMs to interact with web pages, take screenshots, and execute JavaScript in a real browser environment.

## Display Server Support
This fork adds automatic detection and configuration for Linux display servers:
- Automatic X11/Wayland detection
- Dynamic environment variable configuration
- Support for various desktop environments (GNOME, KDE, etc.)
- Fallback mechanisms and robust error handling
- XWayland compatibility

## 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 screenshot
    - `selector` (string, optional): CSS selector for element to screenshot
    - `width` (number, optional, default: 800): Screenshot width
    - `height` (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 field
    - `value` (string): Value to fill
- **puppeteer_select**
  - Select an element with SELECT tag
  - Inputs:
    - `selector` (string): CSS selector for element to select
    - `value` (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:
1. **Console Logs** (`console://logs`)
   - Browser console output in text format
   - Includes all console messages from the browser
2. **Screenshots** (`screenshot://<name>`)
   - PNG images of captured screenshots
   - Accessible via the screenshot name specified during capture

## Key Features
- Browser automation with Linux display server support
- Automatic X11/Wayland detection and configuration
- Console log monitoring
- Screenshot capabilities
- JavaScript execution
- Basic web interaction (navigation, clicking, form filling)

## Configuration
### Claude Desktop Configuration
```json
{
  "mcpServers": {
    "puppeteer": {
      "command": "npx",
      "args": ["ts-node", "/path/to/index.ts"]
    }
  }
}
```

## Installation

### Installing via Smithery

To install Puppeteer Linux for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@PhialsBasement/mcp-puppeteer-linux):

```bash
npx -y @smithery/cli install @PhialsBasement/mcp-puppeteer-linux --client claude
```

### Manual Installation
1. Clone the repository:
```bash
git clone https://github.com/PhialsBasement/MCP-Puppeteer-Linux.git
```

2. Install dependencies:
```bash
npm install
```

3. Start the server:
```bash
ts-node index.ts
```

## Display Server Details
The server automatically detects and configures the appropriate display environment:

### Wayland Support
- Detects Wayland sessions via `WAYLAND_DISPLAY`
- Configures necessary environment variables:
  - `WAYLAND_DISPLAY`
  - `QT_QPA_PLATFORM`
  - `GDK_BACKEND`
  - `MOZ_ENABLE_WAYLAND`
  - `XDG_SESSION_TYPE`

### X11 Support
- Fallback for traditional X11 sessions
- Handles X11-specific variables:
  - `DISPLAY`
  - `XAUTHORITY`
- Supports various desktop environments and window managers

## 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.