Zum Inhalt springen
Dokumentationsmenü

Leitfäden

AI- und LLM-Ressourcen

Plain-Markdown-Versionen dieser Dokumentation, llms.txt, OpenAPI, des Agenten-Skills und anderer Dateien, die KI-Tools lesen können.

Diese Dokumentation wurde so geschrieben, dass sie sowohl von KI-Tools als auch von Menschen gelesen werden kann. Nutzen Sie sie, um Claude, ChatGPT, Cursor oder Ihren eigenen Agenten genaue, aktuelle Kontextinformationen über TradeCatalog zu geben.

Markdown-Versionen jeder SeiteLink zu diesem Abschnitt#

Jede Dokumentationsseite ist auch im einfachen Markdown-Format:

  • Fügen Sie .md zur URL hinzu: /docs/api/products wird zu /docs/api/products.md.
  • Oder bitten Sie um Markdown: senden Sie Accept: text/markdown an eine beliebige /docs-URL.
bash
curl https://tradecatalog.app/docs/api/products.md
curl -H "Accept: text/markdown" https://tradecatalog.app/docs/api/products

Andere TradeCatalog-Seiten geben auch dann Markdown zurück, wenn Sie Accept: text/markdown anfordern.

Schaltflächen auf jeder SeiteLink zu diesem Abschnitt#

Am oberen Rand jeder Dokumentationsseite:

  • Seite kopieren kopiert die Seite als Markdown, bereit zum Einfügen in ein Chat-Fenster.
  • Als Markdown anzeigen öffnet die .md-Version.
  • In Claude öffnen und In ChatGPT öffnen starten ein neues Chat-Fenster, das die Seite liest, sodass Sie Fragen dazu stellen können.

Jeder Codeblock hat auch eine Kopieren-Schaltfläche.

llms.txt und llms-full.txtLink zu diesem Abschnitt#

DateiWas darin enthalten ist
/llms.txtEine kurze Zusammenfassung von TradeCatalog und Links zu den wichtigsten Seiten, gemäß der llms.txt-Konvention.
/llms-full.txtAlle Dokumentationsseiten in einer Markdown-Datei. Fügen Sie sie in ein Projekt ein oder geben Sie sie einem Agenten für den vollständigen Kontext.

Für Code-Assistenten fügen Sie /llms-full.txt zu Ihrem Projekt hinzu, oder bitten Sie den Assistenten, es vor dem Schreiben von TradeCatalog-Code zu lesen.

OpenAPILink zu diesem Abschnitt#

/api/v1/openapi.json beschreibt jeden REST-Endpunkt. Agenten, die OpenAPI verstehen, können direkt aus dieser Datei API-Aufrufe planen.

EntdeckungsdateienLink zu diesem Abschnitt#

DateiFür
/.well-known/api-catalogRFC 9727 API-Katalog: Links zum MCP-Server, zur REST-API, OpenAPI und diesen Dokumenten.
/.well-known/mcp/server-card.jsonDer MCP-Server-Karte: URL, Transport, Authentifizierung und Tools.
/.well-known/agent-skills/index.jsonEin Agenten-Skill, der beschreibt, wie TradeCatalog verwendet wird.
/.well-known/ai-catalog.jsonIndex des MCP-Servers und des Skills.
/.well-known/oauth-protected-resource/mcpOAuth-Metadaten für den MCP-Server. Siehe OAuth für MCP-Clients.
/auth.mdWie Agenten sich authentifizieren, auf einer Seite.

AI-Apps mit Ihrem Daten nutzenLink zu diesem Abschnitt#

Das Lesen von Dokumentation ist eine Sache. Um zu ermöglichen, dass eine AI-App Ihre echten Produkte, Preise und Bestellungen abfragt, verbinden Sie sie mit dem MCP-Server. Er meldet sich als Sie an und sieht nur das, was Sie sehen können.