Dokumentation, die für KI-Agenten erstellt wurde, und nicht nur für Menschen

Jede Seite der Dokumentation hat ein rohes Markdown-Duplikat unter dem gleichen Pfad mit der Endung .md. Öffne /agent-setup - da gibt es auch /agent-setup.md, denselben Text ohne HTML-Wrapper, MDX-Imports sind entfernt, wird als text/markdown ausgeliefert.

Dies speist zwei Aktionen im Seitenmenü: Copy as Markdown (legt reinen Text in die Zwischenablage, um in einen Chat mit dem Modell einzufügen) und View as Markdown (öffnet die .md-Version direkt). Der Agent muss kein DOM parsen - er nimmt fertigen Text.

In der oberen rechten Ecke jeder Seite befindet sich ein Aktionsmenü, speziell für den Agenten-Workflow erstellt:

• Copy as Markdown - reinen Text der Seite in die Zwischenablage
• View as Markdown - .md-Duplikat öffnen
• Open in ChatGPT - Seite mit einem Klick an ChatGPT übergeben
• Open in Claude - dasselbe für Claude
• Connect MCP - Weiterleitung zur MCP-Server-Konfiguration

Statt “Kopiere die URL, öffne den Chat, bitte, gehe auf die Seite” - eine einzige Aktion.

Gemäß dem Standard llmstxt.org liefern wir zwei Dateien aus:

• /llms.txt - Index aller Dokumentationsseiten, gruppiert in Abschnitten (API Reference, Use Cases, Examples, Products). Eine Karte für den Agenten, wo er anfangen soll.
• /llms-full.txt - die gesamte Dokumentation in einer einzigen Plain-Text-Datei. Für Offline-Indizierung in einer Vektordatenbank oder einmalige Einbettung in den Modellkontext.

Wenn du RAG über unsere API aufbaust, ist llms-full.txt ein fertiger Korpus, der Crawlen der Website ist nicht nötig.

Der Vertrag wird in mehreren Formaten für verschiedene Tools ausgeliefert:

• /v1/openapi.json - kanonische OpenAPI 3.1-Spezifikation mit Beispielen und Code-Samples. Für Client-Codegenerierung und jedes OpenAPI-Tooling.
• Swagger-Aliase - /v1/swagger.json, /v1/v3/api-docs und andere leiten mit 301-Weiterleitung auf die kanonische Version, damit Tools, die nach vertrauten Pfaden suchen, nicht stolpern.
• Postman-Collection - /postman/astroway-api.json für den Import in Postman mit einem Klick.

Die Seite /agent-setup/ ist kein allgemeiner Leitfaden, sondern separate Anleitungen für sieben Clients: Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Cline, Codex. Jede gibt eine genaue Konfiguration und ein tools/list curl-Beispiel, um die Verbindung zu überprüfen, bevor Code geschrieben wird.

Auf den API-Referenzseiten hat jede Operation ein eingebettetes try-it-Widget: Du gibst einen Sandbox-Schlüssel ein, bearbeitest den Request-Body, klickst auf “Send” - und siehst die echte Antwort, ohne die Docs zu verlassen. Methode, Pfad und Body-Beispiel werden aus dem bereits generierten curl-Snippet übernommen, daher macht das Widget keine zusätzlichen Anfragen an openapi.json.

Eine einfache These: Wenn dein Produkt ein API ist, muss die Dokumentation nicht nur für das Lesen mit den Augen, sondern auch für die Konsumation durch einen Agenten geeignet sein. Die Hälfte der Integrationen beginnt heute damit, dass ein Entwickler einen Link zu den Docs in Claude oder Cursor wirft und sagt “verbinne das”. Wir haben es so gemacht, dass am Ende reiner Text und ein maschinenlesbarer Vertrag stehen, nicht HTML, das geparst werden muss.

Probier es selbst: Öffne eine beliebige Docs-Seite, klicke auf das Aktionsmenü oben rechts - und du siehst “Open in Claude”.