RoxyBrowser MCP Server [Beta]

English | 中文

⚠️ BETA VERSION NOTICE

This project is currently in beta testing and active development. While we strive for stability, please exercise caution when using this tool in production environments or with critical assets. We recommend closely monitoring software and browser operations when using it with MCP clients to avoid unnecessary losses.

A Model Context Protocol (MCP) server for RoxyBrowser that provides AI assistants with the ability to manage browser instances and obtain Chrome DevTools Protocol (CDP) WebSocket endpoints for automation.

Features

• 🚀 Browser Management: Open and close RoxyBrowser instances programmatically
• 🔗 CDP Integration: Get WebSocket endpoints for Chrome DevTools Protocol automation
• 🤖 AI-Friendly: Seamlessly integrates with AI assistants through MCP
• 🎯 Playwright Ready: Works perfectly with PlayRoxy MCP (RoxyBrowser's customized Playwright MCP)
• 📊 Workspace Support: Manage browsers across different workspaces and projects
• 🛠️ Browser Creation: Create browsers with layered complexity (Simple, Standard, Advanced)
• 🌐 Proxy Management: Built-in proxy validation, testing, and configuration tools
• 🔧 Advanced Configuration: Full control over fingerprints, proxies, and browser settings

Quick Start

Prerequisites

1. RoxyBrowser installed and running
2. RoxyBrowser API enabled in settings:
   • Open RoxyBrowser → API
   • Set "API Status" to "Enable"
   • Copy your API Key
   • Note the API port (default: 50000)

MCP Client Configuration

Add both RoxyBrowser OpenAPI and PlayRoxy MCP to your MCP client configuration:

Claude Desktop / VS Code / Cursor:

{
  "mcpServers": {
    "roxybrowser-openapi": {
      "command": "npx",
      "args": ["@roxybrowser/openapi@beta"],
      "env": {
        "ROXY_API_KEY": "YOUR API KEY",
        "ROXY_API_HOST": "http://127.0.0.1:50000"
      }
    },
    "roxybrowser-playwright-mcp": {
      "command": "npx",
      "args": ["@roxybrowser/playwright-mcp@latest"]
    }
  }
}

Note: Replace YOUR API KEY and YOUR API HOST with your actual RoxyBrowser credentials.

Available Tools

Workspace & Project Management

• roxy_list_workspaces - List all available workspaces and their projects
• roxy_list_accounts - Get platform accounts and credentials in a workspace
• roxy_list_labels - Get browser labels/tags for organization

Browser Management

• roxy_list_browsers - List browsers in a workspace/project with filtering
• roxy_get_browser_detail - Get detailed browser information and configuration
• roxy_open_browsers - Open browsers and get CDP WebSocket endpoints for automation
• roxy_close_browsers - Close running browsers (does NOT free quota)
• roxy_delete_browsers - Delete browser profiles permanently (frees quota)
• roxy_get_connection_info - Get CDP endpoints and PIDs for opened browsers

Browser Creation

• roxy_create_browser_simple - Create browser with basic configuration
• roxy_create_browser_standard - Create browser with common settings (OS, proxy, window size, etc.)
• roxy_create_browser_advanced - Create browser with full control (fingerprint, platform accounts, etc.)

Browser Maintenance

• roxy_update_browser - Update existing browser configuration
• roxy_random_fingerprint - Randomize browser fingerprint
• roxy_clear_local_cache - Clear local browser cache
• roxy_clear_server_cache - Clear server-side browser cache

Utilities

• roxy_validate_proxy_config - Validate proxy configuration
• roxy_system_diagnostics - System health check and diagnostics

Complete Workflow Examples

Example 1: Quick Browser Automation Setup

1. AI: "Create a simple browser in workspace 1 with name 'Test Browser'"
   → Uses roxy_create_browser_simple
   → Returns browser ID ready for use

2. AI: "Open the browser I just created"
   → Uses roxy_open_browsers with the returned ID
   → Returns CDP WebSocket URL like: ws://127.0.0.1:52314/devtools/browser/xxx

3. AI: "Navigate to gmail.com, login, and send emails"
   → Uses PlayRoxy MCP tools automatically (browser_navigate, browser_type, browser_click, etc.)
   → PlayRoxy MCP connects to the opened browser via CDP endpoint

4. AI: "Close the browser when done"
   → Uses roxy_close_browsers

Example 2: Advanced Browser with Proxy Setup

1. AI: "Validate my proxy configuration before creating browsers"
   → Uses roxy_validate_proxy_config
   → Confirms proxy settings are correct

2. AI: "Create a standard browser with SOCKS5 proxy and 1920x1080 resolution in workspace 2"
   → Uses roxy_create_browser_standard with proxy configuration
   → Returns configured browser ID

3. AI: "Open the browser and start automation"
   → Uses roxy_open_browsers → gets CDP endpoint
   → PlayRoxy MCP automatically connects and begins automation tasks

Integration with Playwright MCP

RoxyBrowser MCP is designed to work seamlessly with PlayRoxy MCP, our customized Playwright MCP server built specifically for RoxyBrowser compatibility.

PlayRoxy MCP is based on Microsoft's Playwright MCP with enhancements for RoxyBrowser's fingerprint browser features.

Workflow

1. Use RoxyBrowser OpenAPI MCP to create and open browsers
2. Get CDP WebSocket endpoints from opened browsers
3. Use PlayRoxy MCP to automate browser tasks with full Playwright capabilities

Both servers work together seamlessly when configured in your MCP client (see configuration above).

Development

# Development mode with auto-rebuild
npm run dev

# Build for production
npm run build

API Reference

Environment Variables

| Variable | Required | Default | Description | |----------|----------|---------|-------------| | ROXY_API_KEY | ✅ Yes | - | API key from RoxyBrowser settings | | ROXY_API_HOST | ✅ Yes | http://127.0.0.1:50000 | RoxyBrowser API endpoint | | ROXY_TIMEOUT | No | 30000 | Request timeout in milliseconds |

Error Codes

| Code | Name | Description | |------|------|-------------| | 0 | SUCCESS | Operation completed successfully | | 101 | INSUFFICIENT_QUOTA | Insufficient profiles quota | | 400 | INVALID_PARAMS | Invalid parameters provided | | 401 | UNAUTHORIZED | Authentication failed - invalid API key | | 403 | FORBIDDEN | Access denied - insufficient permissions | | 404 | NOT_FOUND | Resource not found | | 408 | TIMEOUT | Request timeout | | 409 | CONFLICT | Resource conflict or insufficient quota | | 500 | SERVER_ERROR | Internal server error | | 502 | BAD_GATEWAY | Bad gateway - proxy or network issue | | 503 | SERVICE_UNAVAILABLE | Service temporarily unavailable | | 504 | GATEWAY_TIMEOUT | Gateway timeout |

Troubleshooting

Connection Issues

Error: "Failed to connect to RoxyBrowser API"

Check:

1. RoxyBrowser is running
2. API is enabled: RoxyBrowser → API → API Status = Enable
3. Correct API key: Copy from RoxyBrowser → API → API Key
4. Correct port: Check RoxyBrowser → API → Port Settings (default: 50000)
5. No firewall blocking http://127.0.0.1:50000

Authentication Issues

Error: "Configuration Error: API key is required"

Set the environment variable:

export ROXY_API_KEY="your_actual_api_key_from_roxybrowser"

Browser Opening Issues

Error: "Insufficient profiles quota" (Code 101 or 409)

Solutions:

• Purchase more profiles in RoxyBrowser Billing Center
• Delete unused browser profiles using roxy_delete_browsers (closing alone does NOT free quota)
• Upgrade your subscription plan
• Check current quota usage in workspace settings

Some browsers fail to open:

• Check that the browser profiles exist and are not corrupted
• Ensure sufficient system resources (RAM, CPU)
• Verify the dirIds are valid (use roxy_list_browsers first)
• Run roxy_system_diagnostics for comprehensive health check

License

MIT License - see LICENSE file for details.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request