Skip to content
Docs menu

Get started

REST API

MCP

Guides

Reference

Guides

AI and LLM resources

Plain-markdown versions of these docs, llms.txt, OpenAPI, the agent skill and the other files AI tools can read.

View as MarkdownOpen in ClaudeOpen in ChatGPT

These docs are written to be read by AI tools as well as people. Use them to give Claude, ChatGPT, Cursor or your own agent accurate, current context about TradeCatalog.

Markdown versions of every pageLink to this section#

Every docs page is also plain markdown:

  • Add .md to the URL: /docs/api/products becomes /docs/api/products.md.
  • Or ask for markdown: send Accept: text/markdown to any /docs URL.
bash
curl https://tradecatalog.app/docs/api/products.md
curl -H "Accept: text/markdown" https://tradecatalog.app/docs/api/products

Other TradeCatalog pages also return markdown when asked with Accept: text/markdown.

Buttons on every pageLink to this section#

At the top of every docs page:

  • Copy page copies the page as markdown, ready to paste into a chat.
  • View as Markdown opens the .md version.
  • Open in Claude and Open in ChatGPT start a new chat that reads the page, so you can ask questions about it.

Every code block also has a Copy button.

llms.txt and llms-full.txtLink to this section#

FileWhat’s in it
/llms.txtA short summary of TradeCatalog and links to the key pages, following the llms.txt convention.
/llms-full.txtEvery docs page in one markdown file. Paste it into a project or give it to an agent for full context.

For coding assistants, add /llms-full.txt to your project’s docs, or tell the assistant to read it before writing TradeCatalog code.

OpenAPILink to this section#

/api/v1/openapi.json describes every REST endpoint. Agents that understand OpenAPI can plan API calls from it directly.

Discovery filesLink to this section#

FileFor
/.well-known/api-catalogRFC 9727 API catalog: links to the MCP server, the REST API, OpenAPI and these docs.
/.well-known/mcp/server-card.jsonThe MCP server card: URL, transport, auth and tools.
/.well-known/agent-skills/index.jsonAn agent skill describing how to use TradeCatalog.
/.well-known/ai-catalog.jsonIndex of the MCP server and the skill.
/.well-known/oauth-protected-resource/mcpOAuth metadata for the MCP server. See OAuth for MCP clients.
/auth.mdHow agents authenticate, in one page.

Let AI apps use your dataLink to this section#

Reading docs is one thing. To let an AI app look up your real products, prices and orders, connect it to the MCP server. It signs in as you and sees only what you can see.