# Connect to MCP

Integrate with BlockBee using the **Model Context Protocol (MCP)** for AI-assisted development and seamless documentation access. MCP allows AI assistants like Cursor to directly consult BlockBee's documentation, making development faster and more intuitive.

## What is MCP?

The **Model Context Protocol (MCP)** is an open standard that enables AI assistants to connect to external tools and APIs. With BlockBee's MCP integration, you can:

- **AI-Assisted Development**: Get real-time help from AI assistants when building BlockBee integrations
- **Direct API Access**: AI tools can fetch documentation, consult API references, and help debug issues
- **Seamless Workflow**: Integrate BlockBee development directly into your AI-powered development environment

> **INFO**
>**MCP Support**: BlockBee provides full MCP support for all API endpoints, webhooks, and documentation. The MCP integration is fully functional and provides real-time access to our complete documentation ecosystem.


## Use Cases

MCP integration is particularly useful for:

- **API Development**: AI assistants can help you understand endpoints, parameters, and responses
- **Integration Development**: Get AI assistance when building and implementing API integrations
- **Documentation**: Get instant access to BlockBee's complete API reference
- **Error Debugging**: AI assistants can help troubleshoot integration issues
- **Code Generation**: Generate code snippets and integration examples

## Setup

To connect your AI assistant to BlockBee via MCP:

1. **Install MCP Support**: Ensure your AI assistant supports MCP (Cursor, Claude Desktop, etc.)
2. **Configure MCP Server**: Add BlockBee's MCP server to your configuration
3. **Test Connection**: Verify the connection with a simple documentation query

## Configuration

### MCP Server URL

```
https://mcp.blockbee.io/
```

**Note**: This is the official BlockBee MCP server that provides access to our complete documentation and API reference.

### Required Parameters

- **Server URL**: The MCP endpoint URL above
- **No API Key Required**: The MCP tool provides read-only access to documentation

### Example Configuration

```json
{
  "mcpServers": {
    "blockbee-docs": {
      "url": "https://mcp.blockbee.io/"
    }
  }
}
```

> **INFO**
>**No API Key Required**: The MCP integration provides read-only access to BlockBee documentation and doesn't require authentication. For actual API calls, you'll still need to use your BlockBee API key with the API endpoints.


### What You Can Access

Through the MCP integration, AI assistants can:
- Search across all BlockBee documentation with fuzzy matching
- Access complete API reference pages and endpoint documentation
- Retrieve get-started guides, tutorials, and integration examples
- Find specific information about authentication, error handling, and webhooks
- Get real-time documentation updates and access to the latest content
- Navigate through the complete documentation structure programmatically

## Example Request

Here's how an AI assistant would use MCP to interact with BlockBee:

```typescript
// AI Assistant can now:
// 1. Search and fetch API documentation
// 2. Access complete guides and tutorials
// 3. Help debug integration issues using documentation
// 4. Provide real-time documentation assistance

// Example: Searching for authentication information
const authResults = await mcp.blockbee.search_docs("authentication");

// Example: Getting specific documentation
const paymentFlowDoc = await mcp.blockbee.get_doc("doc://remote/api/raw/get-started/custom-payment-flow");
```

### Available MCP Functions

The BlockBee MCP integration provides direct access to:

- **`ping(name?)`**: Health check for the MCP connection
- **`docs_status()`**: Check if documentation is loaded and get basic stats
- **`refresh_docs(maxPages?, timeout?)`**: Fetch and cache documentation pages from the sitemap
- **`list_pages(prefix?, limit?)`**: List available documentation pages with optional filtering
- **`search_docs(query, limit?)`**: Search across all documentation with fuzzy matching
- **`get_doc(uri)`**: Retrieve complete documentation pages by URI
- **`get_section(uri, heading)`**: Get specific sections from documentation by heading text

These functions give you programmatic access to BlockBee's complete documentation ecosystem.

### Practical Examples

Here are some ways you can use the MCP integration:

```typescript
// Search for specific documentation
const authResults = await mcp.blockbee.search_docs("auth", 5);
// Returns: authentication, checkout-payments, webhooks, etc.

// Get specific documentation pages
const authDoc = await mcp.blockbee.get_doc("doc://remote/api/raw/get-started/authentication");
// Returns: Complete authentication guide with API key types, security practices

// Access API endpoint documentation
const endpointDoc = await mcp.blockbee.get_doc("doc://remote/api/raw/api/checkoutrequest");
// Returns: Complete checkout request API documentation

// Find error handling information
const errorDocs = await mcp.blockbee.search_docs("error handling", 3);
// Returns: Error handling guides and related documentation

// Get specific sections from documents
const apiKeySection = await mcp.blockbee.get_section("doc://remote/api/raw/get-started/authentication", "API Key Types");
// Returns: Specific section about API key types and use cases

// List available pages
const allPages = await mcp.blockbee.list_pages(null, 20);
// Returns: List of all available documentation pages

// Health check
const status = await mcp.blockbee.ping("BlockBee MCP");
// Returns: Connection status confirmation
```

## API Reference

Once connected via MCP, you'll have access to:

- **Complete API Reference**: All endpoints, parameters, and responses
- **Webhook Documentation**: Webhook setup and verification guides
- **Integration Examples**: Code samples in multiple programming languages
- **Error Codes**: Comprehensive error handling documentation

> **SUCCESS**
>**Ready to Connect?** Set up MCP integration and start building with AI assistance! 🚀


### Choose Your BlockBee Product

Select the BlockBee product you want to use for your integration:

- **Payment Processing**: [Checkout Payments](/get-started/checkout-payments) - Hosted checkout solution for one-time crypto payments
- **Deposit Management**: [Checkout Deposits](/get-started/checkout-deposits) - Reusable deposit links for multiple payments over time
- **Custom Integration**: [Custom Payment Flow](/get-started/custom-payment-flow) - Build fully customized payment experiences
- **Wallet Management**: [Tickers](/get-started/tickers) - Specify cryptocurrencies and tokens in API requests
- **Self-Custodial**: [Self-Custodial Wallet](/get-started/self-custodial-wallet) - Full control over funds with automated payouts
- **Payouts**: [Payouts](/get-started/payouts) - Send crypto payments to multiple addresses automatically
- **Recurring Payments**: [Subscriptions](/get-started/subscriptions) - Automated recurring crypto payments for services
- **E-commerce**: [E-commerce Platforms](/get-started/ecommerce) - Plug-and-play integrations for popular platforms
- **Storefront**: [Storefront](/get-started/storefront) - Complete hosted online store with crypto payments

**Need help getting started?** Check out our [Authentication](/get-started/authentication) guide and [API Reference](/api/).