Setup MCP

The Bitcoin API ships an MCP (Model Context Protocol) server so any MCP-compatible AI tool — Cursor, VS Code (Copilot), Claude Code, Claude Desktop, Windsurf, Zed, Codex CLI, Gemini CLI, … — can search our docs, fetch full pages, look up code recipes, and inspect the OpenAPI schema while it writes your code.

The endpoint is public, read-only and free. No API key is required.

Server details

• Name: bitcoin-api-docs
• URL: https://bitcoin-api.net/mcp
• Transport: Streamable HTTP

One-click install

Click a button above and your editor will pop up a confirmation dialog. No copy-pasting JSON, no restart juggling.

Manual setup

Most tools accept a common JSON config. If your tool isn’t listed below, try adding this to its MCP settings:

{
  "mcpServers": {
    "bitcoin-api-docs": {
      "type": "http",
      "url": "https://bitcoin-api.net/mcp"
    }
  }
}

Tools without Streamable HTTP

If your MCP client doesn’t support HTTP transport yet (Windsurf, Codex CLI, older Claude Desktop builds, …), use the mcp-remote stdio bridge:

{
  "mcpServers": {
    "bitcoin-api-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://bitcoin-api.net/mcp"]
    }
  }
}

This works in any client that supports stdio-based MCP servers.

Cursor

Or add manually to ~/.cursor/mcp.json (or .cursor/mcp.json in your project):

{
  "mcpServers": {
    "bitcoin-api-docs": {
      "url": "https://bitcoin-api.net/mcp"
    }
  }
}

Then restart Cursor. The agent will auto-discover the tools.

VS Code (GitHub Copilot)

Or add manually to your user settings.json:

{
  "mcp": {
    "servers": {
      "bitcoin-api-docs": {
        "type": "http",
        "url": "https://bitcoin-api.net/mcp"
      }
    }
  }
}

Claude Code

claude mcp add --transport http bitcoin-api-docs https://bitcoin-api.net/mcp

Claude Desktop

1. Open Settings → Connectors → Add custom connector.
2. Set name to bitcoin-api-docs.
3. Set URL to https://bitcoin-api.net/mcp.

Windsurf

Windsurf doesn’t speak Streamable HTTP yet, so use a local proxy. Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "bitcoin-api-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://bitcoin-api.net/mcp"]
    }
  }
}

Zed

Add to ~/.config/zed/settings.json:

{
  "context_servers": {
    "bitcoin-api-docs": {
      "settings": {},
      "enabled": true,
      "url": "https://bitcoin-api.net/mcp"
    }
  }
}

Codex CLI

Add to ~/.codex/config.toml:

[mcp_servers.bitcoin-api-docs]
command = "npx"
args = ["-y", "mcp-remote", "https://bitcoin-api.net/mcp"]

Gemini CLI

Add to ~/.gemini/settings.json:

{
  "mcpServers": {
    "bitcoin-api-docs": {
      "httpUrl": "https://bitcoin-api.net/mcp"
    }
  }
}

Available tools

Once connected, your agent gets six tools:

list_bitcoin_api_docs()

Returns every Bitcoin API documentation chunk with url, anchor and title. Use this to discover what’s available, then call get_bitcoin_api_doc to read a page in full.

get_bitcoin_api_doc(url)

Returns the full markdown of a Bitcoin API documentation page by its URL/path (e.g. /docs/quickstart).

list_bitcoin_api_endpoints()

Returns all available Bitcoin API endpoints with operationId, method, path, summary, description and tags.

get_bitcoin_api_endpoint(operationId)

Returns the raw OpenAPI operation object (parameters, request/response schemas) for the given Bitcoin API operationId — e.g. getCurrentPrice.

get_bitcoin_api_recipes(operationId)

Returns all Bitcoin API code recipes that use a given endpoint, with url, title, description and language.

get_bitcoin_api_recipe(url)

Returns the full markdown of a Bitcoin API recipe by its URL/path, plus metadata (language, tags, endpoints, runUrl, …).

Try it

Once configured, ask your agent something like:

“Using the bitcoin-api-docs MCP, show me how to subscribe to live BTC/USDT prices over WebSocket with Bitcoin API.”

The agent will call list_bitcoin_api_endpoints → get_bitcoin_api_endpoint → get_bitcoin_api_recipes → get_bitcoin_api_recipe and produce a working snippet grounded in the current docs.

Troubleshooting

• Make sure your tool supports Streamable HTTP transport. If not, use the mcp-remote proxy snippets above (Windsurf / Codex CLI).
• Double-check the URL: https://bitcoin-api.net/mcp.
• Restart your editor after editing config files.