Access and search Branch's official API documentation directly within any AI agent or client.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
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 two integration approaches, and the sandbox and production environments. For specific procedures or API details, use search, fetch, and get-endpoint instead — this tool is orientation only.
This tool takes no arguments.
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 two integration approaches, 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 arguments.
{
"type": "object",
"properties": {}
}Gets detailed content for documentation by ID returned from the `search` tool.
| Argument | Type | Description |
|---|---|---|
| id* | string |
| The ID of the documentation to retrieve. Must come from the `search` tool. Recipe IDs are prefixed with `recipe:`, reference page IDs with `ref:`. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the documentation to retrieve. Must come from the `search` tool. Recipe IDs are prefixed with `recipe:`, reference page IDs with `ref:`."
}
}
}Gets detailed information about a specific API endpoint, including security schemes and servers
| Argument | Type | Description |
|---|---|---|
| path* | string | The API endpoint path (e.g. /api/v1/users). |
| method* | string | The HTTP method (e.g. GET, POST, PUT, DELETE). |
{
"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)."
}
}
}Gets the server variables for each server within a specific OpenAPI spec.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Lists all API paths and their HTTP methods with summaries, organized by path. Results can be passed directly into 'get-endpoint'.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}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 arguments.
{
"type": "object",
"properties": {}
}Searches through documentation with the given search query, returning a list of results with ID, title, and URL.
| Argument | Type | Description |
|---|---|---|
| query* | string | search query |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "search query"
}
}
}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'.
| Argument | Type | Description |
|---|---|---|
| pattern* | string | Search pattern (case-insensitive) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"pattern"
],
"properties": {
"pattern": {
"type": "string",
"description": "Search pattern (case-insensitive)"
}
}
}