Branch Docs is an MCP server published by io.github.branch-docs, hosted at docs.branchapp.com. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 10 tools, including list-endpoints, get-endpoint, search-endpoints, get-server-variables, search.
Access and search Branch's official API documentation directly within any AI agent or client.
4 connections through 5 shared values. Tap any node.
Inferred from the host name and headers: what a server runs on, not who runs it.
Lists all API paths and their HTTP methods with summaries, organized by path. Results can be passed directly into 'get-endpoint'.
No parameters.
{
"name": "list-endpoints",
"title": "List API Endpoints",
"description": "Lists all API paths and their HTTP methods with summaries, organized by path. Results can be passed directly into 'get-endpoint'.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Gets detailed information about a specific API endpoint, including security schemes and servers
None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
| Parameter | Type | Description |
|---|---|---|
| path * | string | The API endpoint path (e.g. /api/v1/users). |
| method * | string | The HTTP method (e.g. GET, POST, PUT, DELETE). |
{
"name": "get-endpoint",
"title": "Get Endpoint Details",
"description": "Gets detailed information about a specific API endpoint, including security schemes and servers",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"path",
"method"
],
"properties": {
"path": {
"type": "string",
"description": "The API endpoint path (e.g. /api/v1/users)."
},
"method": {
"type": "string",
"description": "The HTTP method (e.g. GET, POST, PUT, DELETE)."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Performs a deep search through paths, operations, and parameters to discover relevant API endpoints. Use this tool to find specific API capabilities, required parameters, or data models based on search keywords. Results can be passed directly into 'get-endpoint'.
| Parameter | Type | Description |
|---|---|---|
| pattern * | string | Search pattern (case-insensitive) |
{
"name": "search-endpoints",
"title": "Search API Endpoints",
"description": "Performs a deep search through paths, operations, and parameters to discover relevant API endpoints. Use this tool to find specific API capabilities, required parameters, or data models based on search keywords. Results can be passed directly into 'get-endpoint'.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"pattern"
],
"properties": {
"pattern": {
"type": "string",
"description": "Search pattern (case-insensitive)"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Gets the server variables for each server within a specific OpenAPI spec.
No parameters.
{
"name": "get-server-variables",
"title": "Get Server Variables",
"description": "Gets the server variables for each server within a specific OpenAPI spec.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Searches through documentation with the given search query, returning a list of results with ID, title, and URL.
| Parameter | Type | Description |
|---|---|---|
| query * | string | search query |
{
"name": "search",
"title": "Search Documentation",
"description": "Searches through documentation with the given search query, returning a list of results with ID, title, and URL.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "search query"
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Gets detailed content for documentation by ID returned from the `search` tool.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Canonical IDs use project/section/slug. Legacy project/slug, recipe:project/slug and ref:project/slug IDs are also accepted. For a link `/<section>/<slug>` the search tool did not return, use `<project>/<section>/<slug>`, with `<project>` taken from an ID this project already returned. |
| format | string | Custom pages can be authored in HTML. `markdown` converts an HTML custom page to Markdown; omitted or `original` returns the page as authored. |
{
"name": "fetch",
"title": "Fetch Documentation Page",
"description": "Gets detailed content for documentation by ID returned from the `search` tool.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Canonical IDs use project/section/slug. Legacy project/slug, recipe:project/slug and ref:project/slug IDs are also accepted. For a link `/<section>/<slug>` the search tool did not return, use `<project>/<section>/<slug>`, with `<project>` taken from an ID this project already returned."
},
"format": {
"enum": [
"original",
"markdown"
],
"type": "string",
"description": "Custom pages can be authored in HTML. `markdown` converts an HTML custom page to Markdown; omitted or `original` returns the page as authored."
}
}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Call this when the user asks about Branch webhooks, events, notifications, or callbacks — including which events exist, what data an event contains, or which event fires at a given point in worker onboarding or payment. Returns the complete catalog of all 22 Branch webhook events with their payload fields. Use the fetch tool with a listed doc id to get full details and a JSON example for a specific event.
No parameters.
{
"name": "list-webhook-events",
"title": "List Webhook Events",
"description": "Call this when the user asks about Branch webhooks, events, notifications, or callbacks — including which events exist, what data an event contains, or which event fires at a given point in worker onboarding or payment. Returns the complete catalog of all 22 Branch webhook events with their payload fields. Use the fetch tool with a listed doc id to get full details and a JSON example for a specific event.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Call this when the user is new to Branch or is asking what Branch is, what it does, how its core objects relate (organizations, workers, wallets, payment profiles, disbursements), or where to begin an integration. Returns a one-page orientation: the object model, the worker lifecycle from onboarding through payment, the standard integration solutions and which tool covers each, and the sandbox and production environments. For specific procedures or API details, use search, fetch, and get-endpoint instead — this tool is orientation only.
No parameters.
{
"name": "branch-overview",
"title": "Branch Overview",
"description": "Call this when the user is new to Branch or is asking what Branch is, what it does, how its core objects relate (organizations, workers, wallets, payment profiles, disbursements), or where to begin an integration. Returns a one-page orientation: the object model, the worker lifecycle from onboarding through payment, the standard integration solutions and which tool covers each, and the sandbox and production environments. For specific procedures or API details, use search, fetch, and get-endpoint instead — this tool is orientation only.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Call this when the user is building, planning, or reviewing a Branch Disbursements integration, where the partner pays workers through Branch Wallet or Branch Direct. This includes Disbursements with Tax Filing, Co-Branded Card, or Whitelabel. Returns the standard step-by-step integration path: Create Employee, Branch-hosted onboarding, the webhook gate, V2 disbursements, and lifecycle handling, plus the patterns to avoid. Use it before writing or reviewing integration code. Not for Flex EWA, Paycard, or Stripe Connect, which follow different paths.
No parameters.
{
"name": "disbursements-integration",
"title": "Disbursements Integration",
"description": "Call this when the user is building, planning, or reviewing a Branch Disbursements integration, where the partner pays workers through Branch Wallet or Branch Direct. This includes Disbursements with Tax Filing, Co-Branded Card, or Whitelabel. Returns the standard step-by-step integration path: Create Employee, Branch-hosted onboarding, the webhook gate, V2 disbursements, and lifecycle handling, plus the patterns to avoid. Use it before writing or reviewing integration code. Not for Flex EWA, Paycard, or Stripe Connect, which follow different paths.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Call this when the user asks to review, audit, check, or validate Branch integration code, or a pull request that touches Branch API calls, webhook handlers, onboarding flows, or payouts. Returns Branch's audit checklist: critical violations, warnings, and passing checks for each standard solution, plus the report format to use. It catches patterns that mishandle KYC data or cause failed payouts.
No parameters.
{
"name": "audit-integration",
"title": "Audit Integration",
"description": "Call this when the user asks to review, audit, check, or validate Branch integration code, or a pull request that touches Branch API calls, webhook handlers, onboarding flows, or payouts. Returns Branch's audit checklist: critical violations, warnings, and passing checks for each standard solution, plus the report format to use. It catches patterns that mishandle KYC data or cause failed payouts.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Names, descriptions and schemas were written by the server and are shown as data.