Aller au contenu
Menu documentation

Guides

Ressources d'IA et de LLM

Versions en markdown pur de ces documents, llms.txt, OpenAPI, la compétence d'agent et les autres fichiers que les outils d'IA peuvent lire.

Ces documents sont rédigés pour être lus par des outils d'IA ainsi que par des personnes. Utilisez-les pour fournir à Claude, ChatGPT, Cursor ou votre propre agent un contexte précis et à jour sur TradeCatalog.

Versions en markdown de chaque pageLien vers cette section#

Chaque page de documentation est également en markdown pur :

  • Ajoutez .md à l'URL : /docs/api/products devient /docs/api/products.md.
  • Ou demandez le markdown : envoyez Accept: text/markdown à n'importe quelle URL /docs.
bash
curl https://tradecatalog.app/docs/api/products.md
curl -H "Accept: text/markdown" https://tradecatalog.app/docs/api/products

D'autres pages de TradeCatalog renvoient également du markdown lorsqu'on les demande avec Accept: text/markdown.

Boutons sur chaque pageLien vers cette section#

En haut de chaque page de documentation :

  • Copier la page copie la page au format markdown, prête à coller dans un chat.
  • Voir en markdown ouvre la version .md.
  • Ouvrir dans Claude et Ouvrir dans ChatGPT lancent un nouveau chat qui lit la page, vous permettant de poser des questions à son sujet.

Chaque bloc de code possède également un bouton Copier.

llms.txt et llms-full.txtLien vers cette section#

FichierCe qu'il contient
/llms.txtUn résumé court de TradeCatalog et des liens vers les pages clés, suivant la convention llms.txt.
/llms-full.txtToutes les pages de documentation dans un seul fichier markdown. Coller-le dans un projet ou le donner à un agent pour un contexte complet.

Pour les assistants de codage, ajoutez /llms-full.txt à la documentation de votre projet, ou dites à l'assistant de la lire avant d'écrire du code TradeCatalog.

OpenAPILien vers cette section#

/api/v1/openapi.json décrit chaque point de terminaison REST. Les agents qui comprennent OpenAPI peuvent planifier directement des appels d'API à partir de celui-ci.

Fichiers de découverteLien vers cette section#

FichierPour
/.well-known/api-catalogCatalogue d'API RFC 9727 : liens vers le serveur MCP, l'API REST, OpenAPI et ces documents.
/.well-known/mcp/server-card.jsonCarte du serveur MCP : URL, transport, authentification et outils.
/.well-known/agent-skills/index.jsonCompétence d'agent décrivant comment utiliser TradeCatalog.
/.well-known/ai-catalog.jsonIndex du serveur MCP et de la compétence.
/.well-known/oauth-protected-resource/mcpMétadonnées OAuth pour le serveur MCP. Voir OAuth pour les clients MCP.
/auth.mdComment les agents s'authentifient, en une seule page.

Permettre aux applications d'IA d'utiliser vos donnéesLien vers cette section#

Lire la documentation est une chose. Pour permettre à une application d'IA de consulter vos produits, prix et commandes réels, connectez-la au serveur MCP. Il se connecte en votre nom et ne voit que ce que vous pouvez voir.