# How to integrate Brightdata MCP with Mastra AI

```json
{
  "title": "How to integrate Brightdata MCP with Mastra AI",
  "toolkit": "Brightdata",
  "toolkit_slug": "brightdata",
  "framework": "Mastra AI",
  "framework_slug": "mastra-ai",
  "url": "https://composio.dev/toolkits/brightdata/framework/mastra-ai",
  "markdown_url": "https://composio.dev/toolkits/brightdata/framework/mastra-ai.md",
  "updated_at": "2026-05-12T10:04:08.523Z"
}
```

## Introduction

This guide walks you through connecting Brightdata to Mastra AI using the Composio tool router. By the end, you'll have a working Brightdata agent that can download all product listings from this ecommerce site, check crawl status for your recent job, perform google serp search for latest news through natural language commands.
This guide will help you understand how to give your Mastra AI agent real control over a Brightdata account through Composio's Brightdata MCP server.
Before we dive in, let's take a quick look at the key ideas and tools involved.

## Also integrate Brightdata with

- [ChatGPT](https://composio.dev/toolkits/brightdata/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/brightdata/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/brightdata/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/brightdata/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/brightdata/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/brightdata/framework/codex)
- [Cursor](https://composio.dev/toolkits/brightdata/framework/cursor)
- [VS Code](https://composio.dev/toolkits/brightdata/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/brightdata/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/brightdata/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/brightdata/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/brightdata/framework/cli)
- [Google ADK](https://composio.dev/toolkits/brightdata/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/brightdata/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/brightdata/framework/ai-sdk)
- [LlamaIndex](https://composio.dev/toolkits/brightdata/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/brightdata/framework/crew-ai)

## TL;DR

Here's what you'll learn:
- Set up your environment so Mastra, OpenAI, and Composio work together
- Create a Tool Router session in Composio that exposes Brightdata tools
- Connect Mastra's MCP client to the Composio generated MCP URL
- Fetch Brightdata tool definitions and attach them as a toolset
- Build a Mastra agent that can reason, call tools, and return structured results
- Run an interactive CLI where you can chat with your Brightdata agent

## What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.
Key features include:
- MCP Client: Built-in support for Model Context Protocol servers
- Toolsets: Organize tools into logical groups
- Step Callbacks: Monitor and debug agent execution
- OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

## What is the Brightdata MCP server, and what's possible with it?

The Brightdata MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Brightdata account. It provides structured and secure access to Brightdata’s web data platform, so your agent can trigger site crawls, run SERP searches, filter and download datasets, and manage proxy endpoints on your behalf.
- Automated site crawling and extraction: Start large-scale crawl jobs across multiple web pages or entire domains, letting your agent collect structured data from the internet with just a prompt.
- Access to pre-made marketplace scrapers: Browse and select from Brightdata’s collection of pre-built scrapers for popular websites, making it easy to gather structured data without building your own scrapers from scratch.
- Filtered dataset generation and download: Apply custom filters to datasets, check crawl job status, and retrieve the exact data you need by downloading processed results once ready.
- Powerful SERP and web unlocker tools: Perform real-time SERP searches across various engines and leverage web unlocker zones to bypass anti-bot protections and scrape challenging websites.
- Proxy zone and location management: List available proxy zones, cities, and countries to configure how and where your data collection jobs run, optimizing for speed and success.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `BRIGHTDATA_CRAWL_API` | Trigger Site Crawl | Tool to trigger an asynchronous site crawl job to extract content across multiple pages or entire domains. Returns a snapshot_id required by BRIGHTDATA_GET_SNAPSHOT_STATUS (poll until complete) and BRIGHTDATA_GET_SNAPSHOT_RESULTS (call only after completion; querying early yields empty or partial data). Use when you need to start a crawl for a given dataset and list of URLs. Large crawls can produce very large payloads — fetch results incrementally. |
| `BRIGHTDATA_DATASET_LIST` | Browse Available Scrapers | Tool to list all available pre-made scrapers (datasets) from Bright Data's marketplace. Use when you need to browse available data sources for structured scraping. |
| `BRIGHTDATA_FILTER_DATASET` | Filter Dataset | Tool to apply custom filter criteria to a marketplace dataset (BETA). Use after selecting a dataset to generate a filtered snapshot. |
| `BRIGHTDATA_GET_LIST_OF_AVAILABLE_CITIES` | Get Available Cities | Tool to get available static network cities for a given country. Use when you need to configure static proxy endpoints after selecting a country. |
| `BRIGHTDATA_GET_LIST_OF_AVAILABLE_COUNTRIES` | Get Available Countries | Tool to list available countries and their ISO 3166-1 alpha-2 codes. Use when you need to configure zones with valid country codes before provisioning proxies. |
| `BRIGHTDATA_GET_SNAPSHOT_RESULTS` | Download Scraped Data | Tool to retrieve the scraped data from a completed crawl job by snapshot ID. Only call after confirming the job is complete via BRIGHTDATA_GET_SNAPSHOT_STATUS — querying before completion yields empty or partial data. Use after triggering a crawl or filtering a dataset to download the collected data. |
| `BRIGHTDATA_GET_SNAPSHOT_STATUS` | Check Crawl Status | Tool to check the processing status of a crawl job using snapshot ID. Call before attempting to download results to ensure data collection is complete. |
| `BRIGHTDATA_LIST_WEB_UNLOCKER_ZONES` | List Unlocker Zones | Tool to list your configured Web Unlocker zones and proxy endpoints. Use to view available zones for web scraping and bot protection bypass. |
| `BRIGHTDATA_SERP_SEARCH` | SERP Search | Tool to perform SERP (Search Engine Results Page) searches across different search engines using Bright Data's SERP Scrape API. Use when you need to retrieve search results, trending topics, or competitive analysis data. This action submits an asynchronous request and returns a response ID for tracking. |
| `BRIGHTDATA_WEB_UNLOCKER` | Web Unlocker | Tool to bypass bot detection, captcha, and other anti-scraping measures to extract content from websites. Use when you need to scrape websites that block automated access or require JavaScript rendering. Some responses may still contain CAPTCHA challenge pages or incomplete HTML; inspect the response before retrying, and avoid aggressive retry loops. |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

The Brightdata MCP server is an implementation of the Model Context Protocol that connects your AI agent to Brightdata. It provides structured and secure access so your agent can perform Brightdata operations on your behalf through a secure, permission-based interface.
With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster.

## Step-by-step Guide

### 1. Prerequisites

Before starting, make sure you have:
- Node.js 18 or higher
- A Composio account with an active API key
- An OpenAI API key
- Basic familiarity with TypeScript

### 1. Getting API Keys for OpenAI and Composio

OpenAI API Key
- Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key.
- You need credits or a connected billing setup to use the models.
- Store the key somewhere safe.
Composio API Key
- Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs).
- Go to Settings and copy your API key.
- This key lets your Mastra agent talk to Composio and reach Brightdata through MCP.

### 2. Install dependencies

Install the required packages.
What's happening:
- @composio/core is the Composio SDK for creating MCP sessions
- @mastra/core provides the Agent class
- @mastra/mcp is Mastra's MCP client
- @ai-sdk/openai is the model wrapper for OpenAI
- dotenv loads environment variables from .env
```bash
npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv
```

### 3. Set up environment variables

Create a .env file in your project root.
What's happening:
- COMPOSIO_API_KEY authenticates your requests to Composio
- COMPOSIO_USER_ID tells Composio which user this session belongs to
- OPENAI_API_KEY lets the Mastra agent call OpenAI models
```bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key_here
```

### 4. Import libraries and validate environment

What's happening:
- dotenv/config auto loads your .env so process.env.* is available
- openai gives you a Mastra compatible model wrapper
- Agent is the Mastra agent that will call tools and produce answers
- MCPClient connects Mastra to your Composio MCP server
- Composio is used to create a Tool Router session
```typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey as string,
});
```

### 5. Create a Tool Router session for Brightdata

What's happening:
- create spins up a short-lived MCP HTTP endpoint for this user
- The toolkits array contains "brightdata" for Brightdata access
- session.mcp.url is the MCP URL that Mastra's MCPClient will connect to
```typescript
async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["brightdata"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("Brightdata MCP URL:", composioMCPUrl);
```

### 6. Configure Mastra MCP client and fetch tools

What's happening:
- MCPClient takes an id for this client and a list of MCP servers
- The headers property includes the x-api-key for authentication
- getTools fetches the tool definitions exposed by the Brightdata toolkit
```typescript
const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);
```

### 7. Create the Mastra agent

What's happening:
- Agent is the core Mastra agent
- name is just an identifier for logging and debugging
- instructions guide the agent to use tools instead of only answering in natural language
- model uses openai("gpt-5") to configure the underlying LLM
```typescript
const agent = new Agent({
    name: "brightdata-mastra-agent",
    instructions: "You are an AI agent with Brightdata tools via Composio.",
    model: "openai/gpt-5",
  });
```

### 8. Set up interactive chat interface

What's happening:
- messages keeps the full conversation history in Mastra's expected format
- agent.generate runs the agent with conversation history and Brightdata toolsets
- maxSteps limits how many tool calls the agent can take in a single run
- onStepFinish is a hook that prints intermediate steps for debugging
```typescript
let messages: AiMessageType[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end.\n");

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();

rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        brightdata: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
```

## Complete Code

```typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["brightdata"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      brightdata: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "brightdata-mastra-agent",
    instructions: "You are an AI agent with Brightdata tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { brightdata: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();
```

## Conclusion

You've built a Mastra AI agent that can interact with Brightdata through Composio's Tool Router.
You can extend this further by:
- Adding other toolkits like Gmail, Slack, or GitHub
- Building a web-based chat interface around this agent
- Using multiple MCP endpoints to enable cross-app workflows

## How to build Brightdata MCP Agent with another framework

- [ChatGPT](https://composio.dev/toolkits/brightdata/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/brightdata/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/brightdata/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/brightdata/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/brightdata/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/brightdata/framework/codex)
- [Cursor](https://composio.dev/toolkits/brightdata/framework/cursor)
- [VS Code](https://composio.dev/toolkits/brightdata/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/brightdata/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/brightdata/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/brightdata/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/brightdata/framework/cli)
- [Google ADK](https://composio.dev/toolkits/brightdata/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/brightdata/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/brightdata/framework/ai-sdk)
- [LlamaIndex](https://composio.dev/toolkits/brightdata/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/brightdata/framework/crew-ai)

## Related Toolkits

- [Excel](https://composio.dev/toolkits/excel) - Microsoft Excel is a robust spreadsheet application for organizing, analyzing, and visualizing data. It's the go-to tool for calculations, reporting, and flexible data management.
- [21risk](https://composio.dev/toolkits/_21risk) - 21RISK is a web app built for easy checklist, audit, and compliance management. It streamlines risk processes so teams can focus on what matters.
- [Abstract](https://composio.dev/toolkits/abstract) - Abstract provides a suite of APIs for automating data validation and enrichment tasks. It helps developers streamline workflows and ensure data quality with minimal effort.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agentql](https://composio.dev/toolkits/agentql) - Agentql is a toolkit that connects AI agents to the web using a specialized query language. It enables structured web interaction and data extraction for smarter automations.
- [Agenty](https://composio.dev/toolkits/agenty) - Agenty is a web scraping and automation platform for extracting data and automating browser tasks—no coding needed. It streamlines data collection, monitoring, and repetitive online actions.
- [Ambee](https://composio.dev/toolkits/ambee) - Ambee is an environmental data platform providing real-time, hyperlocal APIs for air quality, weather, and pollen. Get precise environmental insights to power smarter decisions in your apps and workflows.
- [Ambient weather](https://composio.dev/toolkits/ambient_weather) - Ambient Weather is a platform for personal weather stations with a robust API for accessing local, real-time, and historical weather data. Get detailed environmental insights directly from your own sensors for smarter apps and automations.
- [Anonyflow](https://composio.dev/toolkits/anonyflow) - Anonyflow is a service for encryption-based data anonymization and secure data sharing. It helps organizations meet GDPR, CCPA, and HIPAA data privacy compliance requirements.
- [Api ninjas](https://composio.dev/toolkits/api_ninjas) - Api ninjas offers 120+ public APIs spanning categories like weather, finance, sports, and more. Developers use it to supercharge apps with real-time data and actionable endpoints.
- [Api sports](https://composio.dev/toolkits/api_sports) - Api sports is a comprehensive sports data platform covering 2,000+ competitions with live scores and 15+ years of stats. Instantly access up-to-date sports information for analysis, apps, or chatbots.
- [Apify](https://composio.dev/toolkits/apify) - Apify is a cloud platform for building, deploying, and managing web scraping and automation tools called Actors. It lets you automate data extraction and workflow tasks at scale—no infrastructure headaches.
- [Autom](https://composio.dev/toolkits/autom) - Autom is a lightning-fast search engine results data platform for Google, Bing, and Brave. Developers use it to access fresh, low-latency SERP data on demand.
- [Beaconchain](https://composio.dev/toolkits/beaconchain) - Beaconchain is a real-time analytics platform for Ethereum 2.0's Beacon Chain. It provides detailed insights into validators, blocks, and overall network performance.
- [Big data cloud](https://composio.dev/toolkits/big_data_cloud) - BigDataCloud provides APIs for geolocation, reverse geocoding, and address validation. Instantly access reliable location intelligence to enhance your applications and workflows.
- [Bigpicture io](https://composio.dev/toolkits/bigpicture_io) - BigPicture.io offers APIs for accessing detailed company and profile data. Instantly enrich your applications with up-to-date insights on 20M+ businesses.
- [Bitquery](https://composio.dev/toolkits/bitquery) - Bitquery is a blockchain data platform offering indexed, real-time, and historical data from 40+ blockchains via GraphQL APIs. Get unified, reliable access to complex on-chain data for analytics, trading, and research.
- [Builtwith](https://composio.dev/toolkits/builtwith) - BuiltWith is a web technology profiler that uncovers the technologies powering any website. Gain actionable insights into analytics, hosting, and content management stacks for smarter research and lead generation.
- [Byteforms](https://composio.dev/toolkits/byteforms) - Byteforms is an all-in-one platform for creating forms, managing submissions, and integrating data. It streamlines workflows by centralizing form data collection and automation.
- [Cabinpanda](https://composio.dev/toolkits/cabinpanda) - Cabinpanda is a data collection platform for building and managing online forms. It helps streamline how you gather, organize, and analyze responses.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and Brightdata MCP?

With a standalone Brightdata MCP server, the agents and LLMs can only access a fixed set of Brightdata tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Brightdata and many other apps based on the task at hand, all through a single MCP endpoint.

### Can I use Tool Router MCP with Mastra AI?

Yes, you can. Mastra AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Brightdata tools.

### Can I manage the permissions and scopes for Brightdata while using Tool Router?

Yes, absolutely. You can configure which Brightdata scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

### How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Brightdata data and credentials are handled as safely as possible.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)
