Skip to content
Last updated

Build with Agents

For the complete documentation index, see llms.txt. Append .md to any page URL for its markdown version.

This documentation is built to be read by agents as well as by people. Everything below is read-only, and needs no credentials. It provides the information for your agent to help you build your integration faster.

Why it matters

An agent working from a web search may hallucinate and invent endpoints. Pointing it at these documentations means it reads the actual parameter names, the actual error codes, and the actual auth scheme.

MCP server

These docs run a Model Context Protocol server. An agent connected to it searches and reads the documentation directly rather than scraping rendered HTML.

https://docs.banxa.com/mcp

It exposes six read-only tools:

ToolWhat it returns
searchPassages matching a query, across all three products
list-apisThe documented APIs and what each is for
get-endpointsEvery endpoint of one API, with method and path
get-endpoint-infoOne endpoint in full (parameters, schemas, security, examples)
get-security-schemesHow to authenticate against one API
get-full-api-descriptionThe complete OpenAPI description

The transport is streamable HTTP. Clients must send Accept: application/json, text/event-stream; a request advertising only application/json is rejected with 406 Not Acceptable.

Connect your client

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

Once connected, ask the agent questions:

  • which Banxa product should I use if I already run my own KYC,
  • what does POST /eapi/v0/ramps accept,
  • what does error 40003 mean

A machine-readable description of the server, including the tool list, is available at https://docs.banxa.com/.well-known/mcp/server-card.json.

Skills

Two skills are published for coding agents. Each is a self-contained instruction document an agent can fetch and follow, rather than a page it has to interpret.

SkillUse it when
choose-banxa-integrationDeciding between Native API, Hosted Checkout, or other future integration patterns
banxa-api-authenticationSigning requests, and debugging 401s or nonce collisions

The index is at /.well-known/agent-skills/index.json, with a SHA-256 digest per skill so a client can verify it fetched the document the index describes.

Every page as markdown

Append .md to any documentation URL to get the markdown source instead of rendered HTML.

curl https://docs.banxa.com/products/native-api/docs/getting-started/authentication.md

llms.txt

Banxa provides llms.txt for LLMs to consume our documentation on their own.

A condensed version of the documentation is available at /llms.txt.

The full corpus is available at /llms-full.txt.

API catalog

https://docs.banxa.com/.well-known/ai-catalog.json) is an RFC 9727 catalog listing every Banxa API with its reference documentation and status endpoint, so a client can enumerate what exists before fetching anything.

In-browser tools

WebMCP is an emerging standard

While it is still stabilising in Chrome, please treat this feature as experimental

Pages on this site register WebMCP tools, so a browser-resident agent can search these docs and look up endpoints without leaving the page.

Crawling policy

/robots.txt names the AI crawlers explicitly and declares how Banxa prefers this documentation to be used. Answer-engine crawlers are welcome. A sitemap lists every canonical page.