Usar com IA

Esta documentação foi feita para ser lida por pessoas e por agentes de IA. Veja como entregar o SDK inteiro ao seu assistente.

Toda página segue o padrão do Fumadocs e também existe em Markdown puro, então dá para colar no Claude, no ChatGPT ou no Cursor sem perder nada.

RecursoEndereçoPara quê
Índice/llms.txtlista de todas as páginas com descrição, para o agente escolher o que ler
Documentação inteira/llms-full.txttodas as funções e tipos num arquivo só
Uma página em Markdown/llms.mdx/docs/<caminho>/content.mdex.: /llms.mdx/docs/servicos/auth/usuario/content.md
Botão Copiar para IAtopo de cada páginacopia a página em Markdown
Menu Abrirtopo de cada páginaabre a página no Claude, ChatGPT, Cursor ou GitHub

Instrução sugerida para o seu agente

CLAUDE.md
Este projeto usa o SDK termo_core da Termotubos (TypeScript e Rust).
Antes de chamar qualquer serviço da Termotubos, leia https://<endereço desta documentação>/llms.txt
e use as funções do termo_core; nunca monte requisições HTTP à mão.
Fixe a versão exata do termo_core (com = no Cargo.toml, sem ^ no package.json).

Como as páginas são organizadas

  • Serviços → um aplicativo por pasta → uma página por entidade (a tag da rota no OpenAPI).
  • Em cada entidade: tabela de resumo, depois cada função com a rota, assinatura TypeScript e Rust, exemplo, argumentos e retorno, e no fim os tipos usados.
  • O nome da função é o mesmo nas duas linguagens, então buscar pelo nome (Ctrl K) acha a função nas duas.

Nesta página