Guides

MCP

Overview

Model Context Protocol (MCP) is an open standard that allows AI applications to securely access external tools and data sources. The Branch MCP server gives AI assistants structured, machine-readable access to the Branch Public API documentation — enabling them to browse endpoints, retrieve schemas, search guides, and execute API calls without manual copy-pasting from web pages.

Branch MCP Server Details

Server URLhttps://docs.branchapp.com/mcp
AuthenticationNone required
TransportStreamable HTTP

Available Tools

API Discovery

  • list-endpoints — Lists all API paths and HTTP methods, organized by path
  • get-endpoint — Returns full details for a specific endpoint, including parameters, request body, and response schemas
  • search-endpoints — Deep search across paths, operations, and component schemas by keyword

Documentation Search

  • search — Searches guide pages and returns matching results with titles and URLs
  • fetch — Retrieves the full content of a guide page by ID

Server Configuration

  • get-server-variables — Returns server variables from the OpenAPI spec (e.g. base URLs for production and sandbox)

API Execution

  • execute-request — Executes a live API call using a HAR request object. Requires a valid Branch API key passed as the apikey header. Available to Branch customers and partners.

Setup

Claude Code (Terminal)

Install Claude

npm install -g @anthropic-ai/claude-code

Install MCP

claude mcp add --transport http branch https://docs.branchapp.com/mcp

Start Claude

claude

At Claude prompt type:

What MCP tools are available?

Claude Desktop

Whether you are a developer exploring our tools or an organization integrating Branch payments into your workflow, you can connect the Branch MCP server directly to the Claude Desktop app.

Because Claude Desktop requires a local entry point to communicate with remote servers, we use a small bridge utility to link your app to our hosted endpoint.

Prerequisites

Claude Desktop: Installed on your machine.

Node.js: Installed (v18 or higher recommended).

  • Check your version: Run node -v in your terminal.

  • If you need to install/update: * Windows/macOS (Manual): Download the "LTS" version from the official Node.js website.

  • The "One-Command" Way (macOS): If you have Homebrew, just run:

    brew install node

  • The Pro Way (All Platforms): We recommend using nvm (Node Version Manager) to easily switch versions. Once installed, run:

    nvm install --lts

Configuration

Open your claude_desktop_config.json file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following to the mcpServers section. If this is your first server, ensure that the file looks like the block below:

{
  "mcpServers": {
    "branch-payments": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://docs.branchapp.com/mcp"
      ]
    }
  }
}

3. Verify Connection

  1. Restart Claude Desktop: Fully quit (Cmd+Q or Ctrl+Q) and relaunch the app.
  2. Look for the Tools: Start a new chat. You should see a Hammer icon or a Connectors option in the (+) menu.
  3. Test it: Ask Claude, _"What Branch tools are available?"

Claude Enterprise & Claude Team Access

If your organization uses Claude Enterprise or Team and you prefer to manage this centrally, an admin can add Branch as a Custom Connector through the Claude web interface:

  • Settings → Connectors → Add custom connector
  • Admin Settings → Connectors → Add custom connector
  • Server URL: https://docs.branchapp.com/mcp
  • We've applied to have Branch listed in Anthropic's MCP connector directory. Once approved, you'll be able to connect with one click from Claude.ai, Claude Desktop, and Claude mobile.

IDE & AI Editor Integration

You can connect the Branch MCP server to your favorite code editor look up documentation without leaving your workspace.

VS Code (Native Copilot)

VS Code now supports MCP servers directly. This allows GitHub Copilot to use Branch tools to help you write and debug payments code.

  1. Open Configuration: Open the VS Code Command Palette (Cmd + Shift + P) and run: MCP: Open User Configuration.
  2. Add the Branch Server: Paste the following block into the mcp.json file that opens:
{
  "mcpServers": {
    "branch-payments": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://docs.branchapp.com/mcp"
      ]
    }
  }
}
  1. To verify open Copilot Chat (Cmd + Alt + I) and click the "Configure Tools" (hammer) icon. You should see branch-payments listed and enabled.

Cursor & Windsurf

For editors that use a global MCP configuration file:

  1. Locate Config:*
    • Cursor: ~/.cursor/mcp.json (or via Settings > Models > MCP)
    • Windsurf: ~/.codeium/windsurf/mcp_config.json
  2. Add the Server: Add the same branch-payments block shown above to the mcpServers section of the file.
{
  "mcpServers": {
    "branch": {
      "url": "https://docs.branchapp.com/mcp"
    }
  }
}

Example Prompts

  • "What endpoints does Branch have for managing worker disbursements?"
  • "How do I create a disbursement for a worker? Walk me through the process."
  • "Send a $25 tip to worker 123456 in org 100000, use external ID tip-2026-001"

Support & Legal

Updated 18 days ago