Package Exports
- puppeteer-real-browser-mcp-server
- puppeteer-real-browser-mcp-server/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (puppeteer-real-browser-mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Puppeteer Real Browser MCP Server
A Model Context Protocol (MCP) server that provides AI assistants with powerful, detection-resistant browser automation capabilities using puppeteer-real-browser.
Table of Contents
- Quick Start for Beginners
- Introduction
- Features
- Prerequisites
- Installation
- Usage
- Available Tools
- Advanced Features
- Configuration
- Troubleshooting
- Development
- Testing
- Contributing
- License
Quick Start for Beginners
What is this?
This is an MCP (Model Context Protocol) server that lets AI assistants like Claude control a real web browser. Think of it as giving Claude "hands" to interact with websites - it can click buttons, fill forms, take screenshots, and much more, all while avoiding bot detection.
Step-by-Step Setup
1. Install Node.js
- Go to nodejs.org
- Download and install Node.js (version 18 or higher)
- Verify installation by opening terminal/command prompt and typing:
node --version
2. Set Up with Claude Desktop (No Installation Required)
The npx command will automatically download and run the latest version, so no manual installation is needed.
3. Configure Claude Desktop
For Windows:
- Open File Explorer and navigate to:
%APPDATA%\Claude\ - Open (or create)
claude_desktop_config.json - Add this configuration:
{
"mcpServers": {
"puppeteer-real-browser": {
"command": "npx",
"args": ["puppeteer-real-browser-mcp-server@latest"]
}
}
}For Mac:
- Open Finder and press
Cmd+Shift+G - Go to:
~/Library/Application Support/Claude/ - Open (or create)
claude_desktop_config.json - Add the same configuration as above
For Linux:
- Navigate to:
~/.config/Claude/ - Open (or create)
claude_desktop_config.json - Add the same configuration as above
4. Restart Claude Desktop
Close and reopen Claude Desktop completely.
5. Test It Works
In Claude Desktop, try saying:
"Initialize a browser and navigate to google.com, then take a screenshot"
If everything is working, Claude should be able to:
- Start a browser
- Navigate to Google
- Take and show you a screenshot
What Can You Do With It?
Once set up, you can ask Claude to:
- Browse websites: "Go to amazon.com and search for laptops"
- Fill forms: "Fill out this contact form with my details"
- Take screenshots: "Show me what this page looks like"
- Extract data: "Get all the product prices from this page"
- Automate tasks: "Log into my account and download my invoice"
- Solve captchas: "Handle any captchas that appear"
Safety Notes
- Claude will show you what it's doing - you can see the browser window
- Always review what Claude does before approving sensitive actions
- Use headless mode (
headless: true) if you don't want to see the browser window - Be respectful of websites' terms of service
Introduction
The Puppeteer Real Browser MCP Server acts as a bridge between AI assistants and browser automation. It leverages puppeteer-real-browser to provide stealth browsing capabilities that can bypass common bot detection mechanisms.
This server implements the Model Context Protocol (MCP), allowing AI assistants to control a real browser, take screenshots, extract content, and more.
Features
- Stealth by default: All browser instances use anti-detection features
- Advanced configuration: Full support for all puppeteer-real-browser options
- Random scrolling: Tools for natural scrolling to avoid detection
- Comprehensive toolset: 10 tools covering all browser automation needs
- Proxy support: Built-in proxy configuration for enhanced privacy
- Captcha handling: Support for solving reCAPTCHA, hCaptcha, and Turnstile
- Error handling: Robust error handling and reporting
Prerequisites
- Node.js >= 18.0.0
- npm or yarn
- Google Chrome or Chromium browser installed
- Basic understanding of TypeScript/JavaScript (for development)
Platform-Specific Requirements
Windows:
- Google Chrome must be installed in one of the standard locations:
C:\Program Files\Google\Chrome\Application\chrome.exeC:\Program Files (x86)\Google\Chrome\Application\chrome.exe%LOCALAPPDATA%\Google\Chrome\Application\chrome.exe
macOS:
- Google Chrome or Chromium must be installed in
/Applications/
Linux:
- Install Chrome/Chromium:
sudo apt-get install -y google-chrome-stableorsudo apt-get install -y chromium-browser - Install xvfb for headless operation:
sudo apt-get install -y xvfb
Installation
From npm
npm install -g puppeteer-real-browser-mcp-serverFrom source
# Clone the repository
git clone https://github.com/withLinda/puppeteer-real-browser-mcp-server.git
cd puppeteer-real-browser-mcp-server
# Install dependencies
npm install
# Build the project
npm run buildUsage
With Claude Desktop
Add to Claude Desktop config:
{
"mcpServers": {
"puppeteer-real-browser": {
"command": "npx",
"args": ["puppeteer-real-browser-mcp-server@latest"]
}
}
}With Other AI Assistants
Start the server:
puppeteer-real-browser-mcp-serverOr if installed from source:
npm startThe server communicates via stdin/stdout using the MCP protocol.
Example Interactions
Basic Web Browsing
User: "Initialize a browser and navigate to example.com"
AI: I'll initialize a stealth browser and navigate to the website.
[Uses browser_init and navigate tools]
User: "Take a screenshot of the main content"
AI: I'll capture a screenshot of the page.
[Uses screenshot tool]Form Automation
User: "Fill in the search form with 'test query'"
AI: I'll type that into the search field.
[Uses type tool with selector and text]
User: "Click the search button"
AI: I'll click the search button.
[Uses click tool]Data Extraction
User: "Get all the product names from this e-commerce page"
AI: I'll extract the product information from the page.
[Uses get_content tool with appropriate selectors]
User: "Save the page content as text"
AI: I'll get the text content of the entire page.
[Uses get_content tool with type: 'text']Working with Proxies
User: "Initialize a browser with a proxy server"
AI: I'll set up the browser with your proxy configuration.
[Uses browser_init with proxy: "https://proxy.example.com:8080"]Available Tools
Core Browser Tools
| Tool Name | Description | Required Parameters | Optional Parameters |
|---|---|---|---|
browser_init |
Initialize stealth browser with advanced options | None | headless, disableXvfb, ignoreAllFlags, proxy, plugins, connectOption |
navigate |
Navigate to a URL | url |
waitUntil |
screenshot |
Take a screenshot of page or element | None | fullPage, selector |
get_content |
Get page content (HTML or text) | None | type, selector |
browser_close |
Close the browser instance | None | None |
Interaction Tools
| Tool Name | Description | Required Parameters | Optional Parameters |
|---|---|---|---|
click |
Standard click on element | selector |
waitForNavigation |
type |
Type text into input field | selector, text |
delay |
wait |
Wait for various conditions | type, value |
timeout |
Behavior Tools
| Tool Name | Description | Required Parameters | Optional Parameters |
|---|---|---|---|
random_scroll |
Perform random scrolling with natural timing | None | None |
Anti-Detection Tools
| Tool Name | Description | Required Parameters | Optional Parameters |
|---|---|---|---|
solve_captcha |
Attempt to solve captchas | type |
None |
Advanced Features
Natural Interactions
The server includes tools designed for natural browsing behavior:
- Random scrolling: Performs scrolling with natural timing and variable distances
This feature helps avoid detection by sophisticated bot-detection systems that analyze user behavior patterns.
Captcha Handling
The server includes basic support for solving common captcha types:
- reCAPTCHA
- hCaptcha
- Cloudflare Turnstile
Note that captcha solving capabilities depend on the underlying puppeteer-real-browser implementation.
Configuration
Automatic Chrome Path Detection
The server automatically detects Chrome installation paths across different operating systems:
- Windows: Searches common installation directories including Program Files and user-specific locations
- macOS: Looks for Chrome in
/Applications/Google Chrome.app/ - Linux: Checks multiple locations including
/usr/bin/google-chrome,/usr/bin/chromium-browser, and snap installations
If Chrome is not found automatically, you can specify a custom path using the customConfig.chromePath option when initializing the browser.
Configuring Custom Options (like headless mode)
Custom options like headless mode are not configured in the MCP config file. Instead, they're passed when initializing the browser using the browser_init tool:
When you ask Claude to initialize a browser, you can specify options like:
Please initialize a browser with headless mode enabled and a 30-second timeoutClaude will then use the browser_init tool with appropriate parameters:
{
"headless": true,
"connectOption": {
"timeout": 30000
}
}Available Browser Options
When initializing with browser_init, you can configure:
headless: true/false (Set to true for headless operation)disableXvfb: true/false (Disable X Virtual Framebuffer)ignoreAllFlags: true/false (Ignore all Chrome flags)proxy: "https://proxy:8080" (Proxy server URL)plugins: ["plugin1", "plugin2"] (Array of plugins to load)connectOption: Additional connection options like:slowMo: 250 (Slow down operations by milliseconds)timeout: 60,000 (Connection timeout)
The MCP config file only tells Claude where to find the server - all browser-specific options are configured through your conversations with Claude.
Browser Options Example
When initializing the browser with browser_init, you can configure:
{
"headless": false,
"disableXvfb": false,
"ignoreAllFlags": false,
"proxy": "https://proxy:8080",
"plugins": ["plugin1", "plugin2"],
"connectOption": {
"slowMo": 250,
"timeout": 60000
}
}Advanced Configuration Examples
Specifying Custom Chrome Path
{
"customConfig": {
"chromePath": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe"
}
}Using a Proxy
{
"headless": true,
"proxy": "https://username:password@proxy.example.com:8080"
}Stealth Mode with Custom Options
{
"headless": false,
"ignoreAllFlags": true,
"disableXvfb": false,
"connectOption": {
"slowMo": 100,
"devtools": false
}
}Server Configuration
For advanced users, you can modify the server behavior by editing the source code:
- Change default viewport size in the
initializeBrowserfunction - Adjust timeout values for various operations
- Enable debug logging
Troubleshooting
Common Issues
"command not found" or "syntax error" when using npx
- This was fixed in version 1.0.3 with the addition of a proper shebang line
- Make sure you're using the latest version:
npx puppeteer-real-browser-mcp-server@latest - For global installation:
npm install -g puppeteer-real-browser-mcp-server@latest - If still having issues, install globally:
npm install -g puppeteer-real-browser-mcp-server - Check your PATH includes npm global binaries:
npm config get prefix
Browser won't start
- Check if Chrome/Chromium is installed in standard locations
- Windows specific:
- Verify Chrome is installed at
C:\Program Files\Google\Chrome\Application\chrome.exeorC:\Program Files (x86)\Google\Chrome\Application\chrome.exe - If Chrome is in a custom location, specify it manually:
Ask Claude: "Initialize browser with custom Chrome path at [your-chrome-path]" - Try running command prompt as Administrator
- Verify Chrome is installed at
- Linux: Install dependencies:
sudo apt-get install -y google-chrome-stable - macOS: Ensure Chrome is in
/Applications/ - Try with
headless: truefirst - Check console output for Chrome path detection messages
Claude doesn't see the MCP server
- Verify
claude_desktop_config.jsonis in the correct location - Check JSON syntax is valid (use jsonlint.com)
- Restart Claude Desktop completely
- Check for any error messages in Claude Desktop
- Verify
Permission denied errors
- On Linux/Mac: Try
sudo npm install -g puppeteer-real-browser-mcp-server - Or use nvm to manage Node.js without sudo
- On Windows: Run command prompt as Administrator
- On Linux/Mac: Try
Detection issues
- Use appropriate delays between actions for better reliability
- Add random delays with
random_scroll - Use proxy if needed:
proxy: "http://proxy.example.com:8080"
Memory leaks
- Always close browser instances with
browser_closewhen done - Don't initialize multiple browsers without closing previous ones
- Check for uncaught exceptions that might prevent cleanup
- Always close browser instances with
Timeout errors
- Increase timeout values:
{ "timeout": 60000 } - Use
waittool before interacting with elements - Check network connectivity and website response times
- Increase timeout values:
Frequently Asked Questions
Q: Does this work with headless browsers?
A: Yes, set headless: true in browser_init options.
Q: Can I use multiple browsers at once? A: Currently supports one browser instance. Close the current one before starting a new one.
Q: What captchas can it solve? A: Supports reCAPTCHA, hCaptcha, and Cloudflare Turnstile through puppeteer-real-browser.
Q: Is this detectable by websites? A: puppeteer-real-browser includes anti-detection features, but no solution is 100% undetectable.
Q: Can I use custom Chrome extensions?
A: Yes, through the plugins option in browser_init.
Q: Does it work on all operating systems? A: Yes, tested on Windows, macOS, and Linux. The server automatically detects Chrome installations on all platforms.
Q: What if Chrome is installed in a non-standard location?
A: Use the customConfig.chromePath option to specify the exact path to your Chrome executable. For example: {"customConfig": {"chromePath": "C:\\Custom\\Chrome\\chrome.exe"}}
Q: Why am I getting "Chrome not found" errors on Windows? A: Make sure Chrome is installed in one of these locations:
C:\Program Files\Google\Chrome\Application\chrome.exeC:\Program Files (x86)\Google\Chrome\Application\chrome.exe%LOCALAPPDATA%\Google\Chrome\Application\chrome.exe
If installed elsewhere, specify the path manually using customConfig.chromePath.
Debug Mode
To enable debug logging:
DEBUG=true npm startOr when running from source:
DEBUG=true npm run devGetting Help
If you're still having issues:
- Check the GitHub Issues
- Create a new issue with:
- Your operating system
- Node.js version (
node --version) - npm version (
npm --version) - Full error message
- Steps to reproduce the problem
Development
Project Structure
puppeteer-real-browser-mcp-server/
├── src/
│ ├── index.ts # Main server implementation
│ └── stealth-actions.ts # Browser interaction functions
├── test/
│ └── test-server.ts # Test script
├── package.json
└── tsconfig.jsonBuilding from Source
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build for production
npm run build
# Test the server
npm testAdding New Tools
To add a new tool:
- Add the tool definition to the
TOOLSarray insrc/index.ts - Implement the tool handler in the
CallToolRequestSchemahandler - Test the new tool functionality
Testing
This project includes a comprehensive testing suite with multiple categories optimized for different purposes:
Quick Tests (CI/CD) - ~30 seconds
npm run test:quick # Fast Jest tests for protocol compliance
npm test # Alias for test:quickComprehensive Tests - ~5-10 minutes
npm run test:full # End-to-end MCP client testingPerformance Testing - ~2-3 minutes
npm run test:performance # Browser performance benchmarkingPerformance tests measure:
- Browser initialization timing (5 trials)
- Navigation performance across different site types
- Screenshot generation speed (viewport vs full page)
- Concurrent operation handling
- Session longevity testing (30+ operations over 30 seconds)
Debug Tools - ~10 seconds
npm run test:debug # Environment diagnostics and troubleshootingDebug tools provide:
- Environment validation (Node.js version, platform, memory)
- Chrome installation detection with specific paths
- Quick server health check with startup timing
- Network connectivity validation
- Build status verification
All Tests - ~7-13 minutes
npm run test:all # Runs quick + full + performance tests
npm run test:dashboard # Unified test runner with reportingThe test dashboard provides:
- Unified execution of multiple test categories
- Real-time progress reporting
- Performance metrics and timing
- Overall test status summary
- Recommendations for failed tests
- JSON results saved to
test-results/directory
Integration Testing
npm run test:integration # Claude Code CLI integration testingFor detailed testing information, see TESTING.md.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.