> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cbpayapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP Server

> Connect your AI editor or assistant to the CBPay documentation with one click

CBPay ships an official [MCP (Model Context Protocol)](https://modelcontextprotocol.io) server at
`https://mcp.cbpayapp.com`. Add it to Cursor, VS Code, Claude or any MCP-compatible
client and your AI assistant can search this documentation, read every endpoint with
its real request/response examples and look up error codes — without leaving your editor.

It is **documentation only and read-only**: it never calls the live API, never needs an
API key, and requires **no authentication**. The transport is streamable HTTP.

## One-click install

<a href="cursor://anysphere.cursor-deeplink/mcp/install?name=cbpay-docs&config=eyJ1cmwiOiJodHRwczovL21jcC5jYnBheWFwcC5jb20ifQ%3D%3D">
  <img className="block dark:hidden" src="https://cursor.com/deeplink/mcp-install-light.svg" alt="Add cbpay-docs MCP server to Cursor" noZoom />

  <img className="hidden dark:block" src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Add cbpay-docs MCP server to Cursor" noZoom />
</a>

<a href="vscode:mcp/install?%7B%22name%22%3A%22cbpay-docs%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.cbpayapp.com%22%7D">
  <img src="https://img.shields.io/badge/VS_Code-Install_cbpay--docs-0098FF?style=for-the-badge" alt="Install cbpay-docs MCP server in VS Code" noZoom />
</a>

<a href="vscode-insiders:mcp/install?%7B%22name%22%3A%22cbpay-docs%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.cbpayapp.com%22%7D">
  <img src="https://img.shields.io/badge/VS_Code_Insiders-Install_cbpay--docs-24bfa5?style=for-the-badge" alt="Install cbpay-docs MCP server in VS Code Insiders" noZoom />
</a>

## Setup by client

<Tabs>
  <Tab title="Cursor">
    Click the **Add to Cursor** button above and confirm the install, or add the
    server manually to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` in your
    project:

    ```json mcp.json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "mcpServers": {
        "cbpay-docs": {
          "url": "https://mcp.cbpayapp.com"
        }
      }
    }
    ```

    The server appears in **Settings → MCP** with its tools ready to use.
  </Tab>

  <Tab title="Claude Code">
    One command from your terminal:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    claude mcp add --transport http cbpay-docs https://mcp.cbpayapp.com
    ```

    Verify with `claude mcp list` — `cbpay-docs` should show as connected.
  </Tab>

  <Tab title="Claude (web & Desktop)">
    On [claude.ai](https://claude.ai) or in Claude Desktop:

    1. Open **Settings → Connectors**.
    2. Click **Add custom connector**.
    3. Name it `cbpay-docs` and paste the URL `https://mcp.cbpayapp.com`.
    4. Save — no authentication step is required.
  </Tab>

  <Tab title="VS Code">
    Click the **VS Code** button above, or add the server manually to your user
    `mcp.json` (**Command Palette → MCP: Open User Configuration**):

    ```json mcp.json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "servers": {
        "cbpay-docs": {
          "type": "http",
          "url": "https://mcp.cbpayapp.com"
        }
      }
    }
    ```

    GitHub Copilot Chat (agent mode) picks up the tools automatically.
  </Tab>

  <Tab title="ChatGPT">
    In ChatGPT (paid plans, with developer mode enabled):

    1. Open **Settings → Connectors → Advanced → Developer mode**.
    2. Click **Create** and paste `https://mcp.cbpayapp.com` as the MCP server URL.
    3. Set authentication to **None** and save.
  </Tab>

  <Tab title="Other clients">
    Any MCP client that supports remote servers over streamable HTTP works. The
    generic configuration is:

    ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "mcpServers": {
        "cbpay-docs": {
          "url": "https://mcp.cbpayapp.com"
        }
      }
    }
    ```

    No API key, no headers, no OAuth — just the URL.
  </Tab>
</Tabs>

## Available tools

| Tool                 | What it does                                                                                      |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| `search_docs`        | Searches the documentation (sections and endpoints) and returns results ranked by relevance       |
| `list_sections`      | Lists the table of contents with each section id and group                                        |
| `get_section`        | Returns the full markdown of a section, including its subsections                                 |
| `list_endpoints`     | Lists the documented endpoints, filterable by group and/or HTTP method                            |
| `get_endpoint`       | Returns the documentation of one endpoint with its curl, request and response examples            |
| `list_groups`        | Lists the products/groups (payouts, payins, banking, crypto, …) with their endpoint counts        |
| `get_errors_catalog` | Returns the API error catalog (HTTP code, `error` code, meaning and category), filterable by text |

## Prompts to try

Once connected, ask your assistant things like:

* "Using the CBPay docs, show me how to create a payout to Chile with curl."
* "What does the `idempotency_key_required` error mean and how do I fix it?"
* "List every payins endpoint and explain the QR flow for Bolivia."
* "How do I verify the signature of a CBPay webhook?"

## FAQ

<AccordionGroup>
  <Accordion title="Do I need an API key or account?">
    No. The MCP server is public and serves documentation only. Your CBPay API key
    is never involved — keep it for your integration code.
  </Accordion>

  <Accordion title="Can it execute operations against my account?">
    No. The server is strictly read-only over documentation content: it cannot
    create payouts, move balances or touch the live API in any way.
  </Accordion>

  <Accordion title="Which transport does it use?">
    Streamable HTTP at `https://mcp.cbpayapp.com`. Clients that only support
    stdio-based local servers can bridge it with a proxy such as `mcp-remote`.
  </Accordion>

  <Accordion title="How is this different from Postman or the site search?">
    Same content, different consumer: the [Postman collection](/en/postman) is for
    humans testing requests, the site search is for humans reading — the MCP server
    is for your AI assistant, so it can answer integration questions with the real
    documented behavior instead of guessing.
  </Accordion>

  <Accordion title="Is the content always up to date?">
    Yes — it is generated from the same documentation you are reading, so every
    release listed in the [changelog](/en/changelog) is reflected in the MCP
    content as well.
  </Accordion>
</AccordionGroup>