Pular para o conteúdo
Menu de documentos

Guias

Recursos de IA e LLM

Versões em markdown simples destas documentações, llms.txt, OpenAPI, a habilidade do agente e outros arquivos que ferramentas de IA podem ler.

Estes documentos foram escritos para serem lidos por ferramentas de IA, bem como por pessoas. Use-os para dar ao Claude, ChatGPT, Cursor ou ao seu próprio agente um contexto preciso e atual sobre o TradeCatalog.

Versões em Markdown de cada páginaLink para esta seção#

Cada página de documentação também é markdown simples:

  • Adicione .md à URL: /docs/api/products se torna /docs/api/products.md.
  • Ou peça em markdown: envie Accept: text/markdown para qualquer URL /docs.
bash
curl https://tradecatalog.app/docs/api/products.md
curl -H "Accept: text/markdown" https://tradecatalog.app/docs/api/products

Outras páginas do TradeCatalog também retornam markdown quando solicitadas com Accept: text/markdown.

Botões em cada páginaLink para esta seção#

No topo de cada página de documentação:

  • Copiar página copia a página como markdown, pronta para colar em um chat.
  • Visualizar como Markdown abre a versão .md.
  • Abrir no Claude e Abrir no ChatGPT iniciam um novo chat que lê a página, para que você possa fazer perguntas sobre ela.

Cada bloco de código também tem um botão Copiar.

llms.txt e llms-full.txtLink para esta seção#

ArquivoO que há nele
/llms.txtUm resumo curto do TradeCatalog e links para as páginas principais, seguindo a convenção llms.txt.
/llms-full.txtTodas as páginas de documentação em um único arquivo markdown. Cole-o em um projeto ou forneça-o a um agente para contexto completo.

Para assistentes de codificação, adicione /llms-full.txt ao seu projeto de documentação, ou peça ao assistente para lê-lo antes de escrever código do TradeCatalog.

OpenAPILink para esta seção#

/api/v1/openapi.json descreve cada ponto final REST. Agentes que entendem OpenAPI podem planejar chamadas de API diretamente a partir dele.

Arquivos de descobertaLink para esta seção#

ArquivoPara
/.well-known/api-catalogCatálogo de API RFC 9727: links para o servidor MCP, a API REST, OpenAPI e estas documentações.
/.well-known/mcp/server-card.jsonCartão do servidor MCP: URL, transporte, autenticação e ferramentas.
/.well-known/agent-skills/index.jsonHabilidade de agente descrevendo como usar o TradeCatalog.
/.well-known/ai-catalog.jsonÍndice do servidor MCP e da habilidade.
/.well-known/oauth-protected-resource/mcpMetadados OAuth para o servidor MCP. Consulte OAuth para clientes MCP.
/auth.mdComo os agentes se autenticam, em uma única página.

Permita que aplicativos de IA usem seus dadosLink para esta seção#

Ler documentação é uma coisa. Para permitir que um aplicativo de IA consulte seus produtos, preços e pedidos reais, conecte-o ao servidor MCP. Ele entra como você e vê apenas o que você pode ver.