Sign inGet started

llms.txt und Markdown-Dokumentation

Alles auf dieser Dokumentationsseite existiert zweifach: als das HTML, das Sie gerade lesen, und als Markdown, das für maschinelle Verarbeitung erstellt wurde. Agenten benötigen sauberen, linkreichen Text, den sie indizieren, abrufen oder in den Kontext laden können. Diese Seite erklärt die drei maschinenlesbaren Formen und wie sie zusammenhängen.

Das Korpus

  • /llms.txt, der Index: Eine flache Übersicht jeder Seite, mit einer einzeiligen Zusammenfassung und einem Link für jede. Er folgt der llms.txt-Konvention und ist klein genug, um in den Kontext zu passen. Verwenden Sie ihn als Ausgangspunkt, wenn ein Agent Seiten bei Bedarf abruft.
  • /llms-full.txt, das vollständige Korpus: Alle Dokumentationsseiten als Markdown in einer Datei zusammengefügt. Verwenden Sie es für eine Long-Context-Sitzung, einen RAG-Ingestion-Job oder eine projektweite Wissensdatei, die das komplette Korpus benötigt.
  • Das seitenweise Markdown-Pendant: Jede Seite ist auch als rohes Markdown verfügbar, sodass ein Agent eine einzelne Seite ohne den Rest des Korpus abrufen kann.
Alle drei werden aus denselben Quellen wie die HTML-Seite generiert und bei jedem Deployment neu erstellt, sodass sie nie hinter der veröffentlichten Dokumentation zurückbleiben.

Die Copy-page-Funktion

Sie müssen sich diese URLs selten merken. Jede Seite in den Bereichen Guides, API-Referenz, SDK und Wissensdatenbank bietet ein Copy page-Menü, das die maschinenlesbaren Formen direkt an Ihre Tools übergibt:
  • Copy page as Markdown: Das Markdown-Pendant der aktuellen Seite, bereit zum Einfügen in einen Chat oder eine Kontextdatei.
  • Open llms-full.txt: Das vollständige Korpus für Aufgaben, die mehr als eine Seite benötigen.
  • Copy MCP install command: Der einzeilige Befehl, der den gehosteten MCP-Server zur Konfiguration Ihres Clients hinzufügt, sodass der Agent, der die Seite liest, auch die Tools verbinden kann, die zum Handeln benötigt werden.
  • Connect to Cursor / Connect to VS Code: MCP-Einrichtung per Klick für zwei gängige agentenbasierte Editoren.
Das Dashboard bietet eine kompaktere Variante derselben Idee. Auf der E-Mail-Onboarding-Seite kopiert das Copy for AI-Menü das aktuelle Codebeispiel als einfügebereiten Prompt oder öffnet es direkt in Cursor, Claude oder ChatGPT.

Die API-Referenz weicht nie ab

Der API-Referenzbereich wird aus der OpenAPI-Spezifikation generiert, die die API validiert. Sein Markdown-Pendant stammt aus derselben Quelle. Wenn sich ein Endpunkt ändert, werden Spezifikation, HTML, Markdown und llms-full.txt gemeinsam neu generiert. Ein Agent, der das Korpus liest, liest daher direkt den API-Vertrag. Beginnen Sie bei der Einführung in die API-Referenz, um zu sehen, wie die Referenz aufgebaut ist.

Preisseiten enthalten ihre Preise

Eine Preisseite und ihr Markdown-Pendant werden aus denselben Tarifdaten im selben Request gerendert. /products/email/pricing.md liefert die E-Mail-Tarife und beide Volumenstaffeln, /pricing/email.md das Versandplan-Raster für jedes Sendevolumen, /pricing/sms.md die länderspezifische Preiskarte, /pricing/voice/us.md die Minutenpreise für Anrufe zu einem Ziel und /pricing/sms/fees.md die Carrier- und 10DLC-Gebühren. Beginnen Sie bei /pricing.md: Dort werden alle Produkte aufgelistet, die einen Tarif veröffentlichen, ihre Preisseite und die .md-URL, unter der die Tarife zu finden sind. Tarife, die aus dem Abrechnungskatalog stammen, werden bei Abruf abgefragt und nicht in die Datei kopiert, sodass das Pendant keinen Preis nennen kann, den die Seite inzwischen geändert hat. Alle Beträge sind in US-Dollar und jede Tabelle benennt ihre Einheit.

Auswahl der richtigen Form

Der Agent soll…Übergeben Sie…
Erkennen, was existiert, und Seiten bei Bedarf abrufen/llms.txt
Das gesamte Dokumentationskorpus im Kontext oder in einem RAG-Store haben/llms-full.txt
Ein Thema präzise verstehenDas Markdown der jeweiligen Seite über Copy page
Auf Bird zugreifen und nicht nur darüber lesenDen MCP-Server; Dokumentation allein kann keine E-Mail senden
Für eine geführte End-to-End-Einrichtung, die den MCP-Server installiert, den Editor verbindet und das Korpus einbindet, folgen Sie dem AI-Onboarding.

Nächste Schritte

  • AI-Onboarding: MCP-Server installieren, Editor verbinden und Korpus einbinden.
  • MCP-Server: Ihren Agenten befähigen, auf Bird zuzugreifen und nicht nur darüber zu lesen.
  • Agent Skills: Vorgefertigte Workflows, die Coding-Agenten die Bird-Oberfläche beibringen.