Skip to main content

MCP Server

BlockWyre hosts a Model Context Protocol (MCP) server for this documentation. Point your AI editor at it once, and the assistant answers questions about BlockWyre by reading the current docs and the current API reference — not from whatever it memorised months ago.

Server URLhttps://docs.blockwyre.com/mcp
TransportStreamable HTTP
AuthenticationNone
Suggested nameblockwyre-docs

What it does, and what it does not​

Documentation only

This server reads published material and nothing else. It is the same content you are reading now, plus the public OpenAPI description of the API.

It can:

  • Search and read every page of these guides and of the API reference.
  • Look up an operation of the public OpenAPI description and return its parameters, request body and response schemas, with $refs already resolved so the field names are the real ones.

It cannot:

  • See your account, your balances, your transactions or your keys.
  • Call the BlockWyre API on your behalf.
  • Change anything, anywhere.

There are no credentials to configure, rotate or leak. Connecting to it exposes no more than opening this page in a browser.

Setup​

Claude Code​

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

Add --scope project to write the entry into a .mcp.json at the root of your repository, so everyone on the team picks it up from version control:

{
"mcpServers": {
"blockwyre-docs": {
"type": "http",
"url": "https://docs.blockwyre.com/mcp"
}
}
}
Do not omit the transport type

An entry that carries only url is skipped — you get no tools and no error message. Keep "type": "http" (the MCP spec name "streamable-http" also works).

Cursor​

Add to ~/.cursor/mcp.json for every project, or .cursor/mcp.json for one:

{
"mcpServers": {
"blockwyre-docs": {
"url": "https://docs.blockwyre.com/mcp"
}
}
}

VS Code​

Add to .vscode/mcp.json. Note that VS Code's root key is servers, not mcpServers:

{
"servers": {
"blockwyre-docs": {
"type": "http",
"url": "https://docs.blockwyre.com/mcp"
}
}
}

Windsurf​

Add to ~/.codeium/windsurf/mcp_config.json. Windsurf is the odd one out: the key is serverUrl, not url.

{
"mcpServers": {
"blockwyre-docs": {
"serverUrl": "https://docs.blockwyre.com/mcp"
}
}
}

Claude Desktop and claude.ai​

Open Settings → Connectors → Add custom connector, paste https://docs.blockwyre.com/mcp, and click Add. Leave the advanced OAuth fields empty — this server does not authenticate.

Available tools​

ToolWhat it returns
list_doc_sectionsThe documentation sections and the pages in each. Useful to orient before searching.
search_docsRanked pages with an excerpt, for a full-text query across the guides and the API reference.
read_docThe full markdown of one page, by the id that search_docs returned.
search_endpointsMatching API operations, by path, summary, tag or operationId.
list_endpointsEvery operation in the public OpenAPI description — method, path and summary — optionally filtered by OpenAPI tag.
get_endpointFull detail for one operation: parameters, request body and response schemas.

Verifying the connection​

In Claude Code, run /mcp. blockwyre-docs should be listed as connected, with six tools.

The server also answers an unauthenticated health check, which reports how much content the current snapshot covers:

curl https://docs.blockwyre.com/mcp-health
{ "status": "ok", "generatedAt": "<when the snapshot was built>", "pages": <pages>, "endpoints": <operations> }

pages and endpoints count what the current snapshot holds, so they change as the documentation does.

Then ask your assistant something it could only answer from the docs:

  • "Using the BlockWyre docs, how do I sign a request with Ed25519?"
  • "What does BlockWyre's webhook signature validation look like?"
  • "Show me the request body for creating a bank account in the BlockWyre API."

Troubleshooting​

SymptomCause
The server never appears, and nothing is loggedThe entry has url but no type. Clients that require a transport type skip the entry silently. Add "type": "http".
VS Code ignores the file entirelyThe root key is servers in VS Code, while every other client uses mcpServers.
Windsurf lists the server but loads no toolsWindsurf expects serverUrl instead of url.
The configuration looks right but nothing loadsMost editors read MCP configuration only at startup. Restart it.
Tools appear, but every call times outConfirm your network allows HTTPS to docs.blockwyre.com. Proxies that terminate TLS can interfere with the streamed response.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!