Guides
  1. Get Started

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, and search guides without manual copy-pasting from web pages.

Branch MCP Server Details

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

Note: Your MCP client might present an optional authentication or "connect" step. The Branch documentation server requires no credentials.

Available Tools


Overview

  • branch-overview — Returns a one-page introduction to Branch: the core object model (organizations, workers, wallets, payment profiles, disbursements, invoices), the worker lifecycle from onboarding through payment, the two integration approaches, and the sandbox and production environments

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)

Webhooks

  • list-webhook-events — Returns the complete catalog of all 22 Branch webhook events with their payload fields and links to full details

Setup

Claude Code (Terminal)

Install Claude Code

macOS, Linux, or WSL:

curl -fsSL https://claude.ai/install.sh | bash

Windows PowerShell:

irm https://claude.ai/install.ps1 | iex

Homebrew and npm installs are also available. The npm package requires Node.js 22 or later:

  • brew install --cask claude-code
  • npm install -g @anthropic-ai/claude-code

Add the Branch MCP server

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

Start Claude

claude

At the 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. Claude Desktop connects to remote MCP servers natively, so no bridge utility, configuration file, or Node.js installation is required.

Add the Connector

  1. Open Settings (Cmd+, on macOS, Ctrl+, on Windows), then click Connectors in the sidebar.
  2. Click Add at the top right, then select Add custom connector.
  3. Enter the server URL: https://docs.branchapp.com/mcp
  4. Click Add. Branch requires no authentication, so you can skip any credential prompts.

Verify Connection

  1. Start a new chat and click the plus sign + at the bottom left of the message box.
  2. Hover over Connectors. You should see Branch listed.
  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 to look up documentation without leaving your workspace.

VS Code (Native Copilot)

VS Code supports remote MCP servers over HTTP directly, with no bridge utility required. 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:
{
  "servers": {
    "branch-payments": {
      "type": "http",
      "url": "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 block below to the mcpServers section of the file. Windsurf also accepts serverUrl in place of url.
{
  "mcpServers": {
    "branch-payments": {
      "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."
  • "What webhooks does Branch send when a worker finishes onboarding?"

Support & Legal

Updated 9 days ago