GitHub - brightdata/brightdata-mcp: A powerful Model Context Protocol (MCP) server that provides an all-in-one solution for public web access. (original) (raw)

Bright Data MCP

Enhance AI Agents with Real-Time Web Data

🌟 Overview

Welcome to the official Bright Data Model Context Protocol (MCP) server, enabling LLMs, agents and apps to access, discover and extract web data in real-time. This server allows MCP clients, such as Claude Desktop, Cursor, Windsurf and others, to seamlessly search the web, navigate websites, take action and retrieve data - without getting blocked - perfect for scraping tasks.

🎬 Demo

The videos below demonstrate a minimal use case for Claude Desktop:

bright-data-mcp-scraping-browser-demo-claude.mp4 bright-data-mcp-with-claude-quick-demo.mp4

For YouTube tutorials and demos: Demo

✨ Features

Real-time Web Access: Access up-to-date information directly from the web
Bypass Geo-restrictions: Access content regardless of location constraints
Web Unlocker: Navigate websites with bot detection protection
Browser Control: Optional remote browser automation capabilities
Seamless Integration: Works with all MCP-compatible AI assistants

🚀 Quickstart with Claude Desktop

Install nodejs to get the npx command (node.js module runner). Installation instructions can be found on the node.js website
Go to Claude > Settings > Developer > Edit Config > claude_desktop_config.json to include the following:

{ "mcpServers": { "Bright Data": { "command": "npx", "args": ["@brightdata/mcp"], "env": { "API_TOKEN": "", "WEB_UNLOCKER_ZONE": "", "BROWSER_ZONE": "<optional browser zone name, defaults to mcp_browser>" } } } }

🔧 Available Tools

List of Available Tools

⚠️ Security Best Practices

Important: Always treat scraped web content as untrusted data. Never use raw scraped content directly in LLM prompts to avoid potential prompt injection risks. Instead:

Filter and validate all web data before processing
Use structured data extraction rather than raw text (web_data tools)

🔧 Account Setup

Make sure you have an account on brightdata.com (new users get free credit for testing, and pay as you go options are available)
Get your API key from the user settings page
(Optional) Create a custom Web Unlocker zone
- By default, we create a Web Unlocker zone automatically using your API token
- For more control, you can create your own Web Unlocker zone in your control panel and specify it with the WEB_UNLOCKER_ZONE environment variable
(Optional) To enable browser control tools:
- By default, the MCP tries to fetch credentials of mcp_browser zone.
- If you don't have an mcp_browser zone, you can :
  * Create a Browser API zone in your control panel or use an existing one and specify its name using the BROWSER_ZONE environment variable

🔌 Other MCP Clients

To use this MCP server with other agent types, you should adapt the following to your specific software:

The full command to run the MCP server is npx @brightdata/mcp
The environment variable API_TOKEN=<your-token> must exist when running the server
(Optional) Set BROWSER_ZONE=<zone-name> to specify a custom Browser API zone name (defaults to mcp_browser)

🔄 Breaking Changes

Browser Authentication Update

BREAKING CHANGE: The BROWSER_AUTH environment variable has been replaced with BROWSER_ZONE.

Before: Users needed to provide BROWSER_AUTH="user:pass" from the Browser API zone
Now: Users only need to specify the browser zone name with BROWSER_ZONE="zone_name"
Default: If not specified, the system uses mcp_browser zone automatically
Migration: Replace BROWSER_AUTH with BROWSER_ZONE in your configuration and specify your Browser API zone name if mcp_browser doesn't exists

🔄 Changelog

CHANGELOG.md

🎮 Try Bright Data MCP Playgrounds

Want to try Bright Data MCP without setting up anything?

Check out this playground on Smithery:

This platform provide an easy way to explore the capabilities of Bright Data MCP without any local setup. Just sign in and start experimenting with web data collection!

💡 Usage Examples

Some example queries that this MCP server will be able to help with:

"Google some movies that are releasing soon in [your area]"
"What's Tesla's current market cap?"
"What's the Wikipedia article of the day?"
"What's the 7-day weather forecast in [your location]?"
"Of the 3 highest paid tech CEOs, how long have their careers been?"

⚠️ Troubleshooting

Timeouts when using certain tools

Some tools can involve reading web data, and the amount of time needed to load the page can vary by quite a lot in extreme circumstances.

To ensure that your agent will be able to consume the data, set a high enough timeout in your agent settings.

A value of 180s should be enough for 99% of requests, but some sites load slower than others, so tune this to your needs.

spawn npx ENOENT

This error occurs when your system cannot find the npx command. To fix it:

Finding npm/Node Path

macOS:

Shows path like /usr/local/bin/node

Windows:

Shows path like C:\Program Files\nodejs\node.exe

Update your MCP configuration:

Replace the npx command with the full path to Node, for example, on mac, it will look as follows:

"command": "/usr/local/bin/node"

👨‍💻 Contributing

We welcome contributions to help improve the Bright Data MCP! Here's how you can help:

Report Issues: If you encounter any bugs or have feature requests, please open an issue on our GitHub repository.
Submit Pull Requests: Feel free to fork the repository and submit pull requests with enhancements or bug fixes.
Coding Style: All JavaScript code should follow Bright Data's JavaScript coding conventions. This ensures consistency across the codebase.
Documentation: Improvements to documentation, including this README, are always appreciated.
Examples: Share your use cases by contributing examples to help other users.

For major changes, please open an issue first to discuss your proposed changes. This ensures your time is well spent and aligned with project goals.

📞 Support

If you encounter any issues or have questions, please reach out to the Bright Data support team or open an issue in the repository.