Zum Inhalt springen
Tutorial

Fügen Sie llms.txt zu Ihrer API hinzu, um die KI-Erkennbarkeit zu verbessern

| 8 min read

llms.txt teilt LLMs mit, was Ihre API in 6x weniger Tokens als HTML tut. Schritt-für-Schritt-Anleitung mit Spezifikationsformat, zweistufigem Ansatz und einem Beispiel aus der Praxis.

Digital matrix code representing machine-readable text
Photo by Markus Spiske on Unsplash

Sie veröffentlichen API-Dokumente in HTML. Ein Entwickler liest sie, kopiert einen Curl-Befehl und integriert Ihre API. Dieser Workflow funktioniert immer noch. Aber ein zunehmender Anteil Ihrer „Leser“ sind LLMs, und sie verarbeiten Ihre HTML-Dokumente haben ihren Preis: Eine typische Dokumentationsseite verbrennt 12.000 Token, bevor das Modell a extrahiert einzelne Endpunkt-URL. Die HTML-Tags, Navigations-Chrome und JavaScript, die Ihre Website ausliefert, bieten keinen Mehrwert für ein LLM.

llms.txt löst das. Es handelt sich um eine einfache Markdown-Datei im Stammverzeichnis Ihrer Domain, die beschreibt Was Ihre API tut, listet Ihre Endpunkte auf und enthält Links zu detaillierten Dokumenten. LLMs analysieren es in 6x weniger Zeit Tokens als das entsprechende HTML. Über 849 Websites haben es übernommen, darunter Anthropic, Cloudflare, Stripe und Mintlify.

Was llms.txt ist (und was nicht)

Der llms.txt Die von Jeremy Howard vorgeschlagene Spezifikation definiert eine Standarddatei unter /llms.txt auf jeder Website. Es verwendet Markdown-Überschriften, Blockzitate und Linklisten Beschreiben Sie ein Produkt anhand von Sprachmodellen.

Stellen Sie sich das so vor: robots.txt teilt Suchcrawlern mit, welche Seiten indexiert werden sollen. llms.txt teilt Sprachmodellen mit, was Ihr Produkt tut und wo die Details zu finden sind.

# robots.txt - tells crawlers what to index
User-agent: *
Allow: /

# llms.txt - tells LLMs what your product does
# Served at /llms.txt as structured Markdown

llms.txt ist kein Ersatz für Ihre Dokumentationsseite. Es ist ein prägnanter Index, für den Maschinenverbrauch formatiert. Menschen können es auch lesen, aber die primäre Zielgruppe ist jeder LLM Das muss Ihre API verstehen, bevor Sie Code generieren oder Fragen dazu beantworten können.

Das Spezifikationsformat

Das Format ist für jede Zeile beabsichtigt. Hier ist die Struktur:

# Product Name

> One-line product description with key capabilities.

## Section Name

- [Link Title](https://example.com/page): Brief description
- [Another Link](https://example.com/other): Brief description

## Optional: Additional sections

More structured content as needed.
  • Überschrift H1: Ihr Produkt- oder Projektname. Eine pro Datei.
  • Blockzitat: Eine einzeilige Beschreibung dessen, was das Produkt tut.
  • H2-Abschnitte: Gruppieren Sie Ihre Links nach Kategorien (Dokumentation, Endpunkte, Tools).
  • Linklisten: Jede Zeile enthält einen Markdown-Link, gefolgt von einem Doppelpunkt und einer Beschreibung.

Kein HTML. Keine Frontsache. Keine benutzerdefinierte Syntax. Jeder Markdown-Parser kann es lesen, und jeder LLM kann es lesen Extrahieren Sie daraus strukturierte Informationen ohne Spezialwerkzeuge.

Warum Token wichtig sind: Markdown vs. HTML

Jedes LLM verfügt über ein Kontextfenster. Für das Parsen aufgewendete Token <div class="nav-wrapper"> Und <script src="analytics.js"> sind Token, die das Modell nicht für Verständnis ausgeben kann Ihr API-Schema. Hier ist die Mathematik:

HTML documentation page:     ~12,000 tokens
Same content as Markdown:     ~2,000 tokens
Savings:                      ~83% fewer tokens

Eine HTML-Dokumentationsseite enthält Navigationsleisten, Fußzeilen, Seitenleisten, Meta-Tags und eingebettete Elemente Skripte. Entfernen Sie all das und konvertieren Sie es in Markdown, und Sie erhalten die gleichen Informationen etwa ein Sechstel der Token. Dieser Unterschied gilt für LLMs, die nahe ihrer Kontextgrenze arbeiten Bestimmt, ob Ihre vollständige API-Referenz in eine einzelne Eingabeaufforderung passt.

Der zweistufige Ansatz: llms.txt + llms-full.txt

Die Spezifikation definiert zwei Dateien mit unterschiedlichen Rollen:

  • llms.txt ist die Zusammenfassung. Produktname, einzeilige Beschreibung, und eine Linkliste mit kurzen Beschreibungen. Zielgröße: unter 10 KB. Ein LLM liest dies vor Verstehen Sie, was Ihre API bietet, und entscheiden Sie, welchen Links Sie folgen, um Einzelheiten zu erfahren.
  • llms-full.txt ist die vollständige Referenz. Es bettet den Inhalt ein Diese Links verweisen auf eine einzelne Datei. Anforderungsschemata, Antwortbeispiele, Authentifizierung Flüsse, Fehlercodes. Zielgröße: unter 100 KB. Ein LLM liest dies, wenn es eine Generierung benötigt Arbeitscode für Ihre API.

Beginnen Sie mit llms.txt. Hinzufügen llms-full.txt Sobald Sie möchten, dass LLMs generiert werden Integrationscode, ohne externen Links zu folgen.

Schritt für Schritt: Schreiben Sie Ihre eigene llms.txt

1. Beginnen Sie mit der Produktidentität

Beginnen Sie mit einem H1, das Ihren Produktnamen enthält, gefolgt von einem Anführungszeichen, das Ihr Produkt beschreibt in einem Satz. Seien Sie konkret. Berücksichtigen Sie die Anzahl der Endpunkte, Schlüsselfunktionen und etwaige Unterscheidungsmerkmale.

# Acme API

&gt; REST API for payment processing. 12 endpoints covering charges, refunds, subscriptions, and webhooks.

## Documentation

- [API Reference](https://docs.acme.com/api): Full endpoint reference with request/response schemas
- [Authentication](https://docs.acme.com/auth): API key setup, OAuth 2.0 flows, and webhook signing
- [Quickstart](https://docs.acme.com/quickstart): Send your first charge in 5 minutes

## Endpoints

- Create charge: POST https://api.acme.com/v1/charges
- Get charge: GET https://api.acme.com/v1/charges/:id
- Create refund: POST https://api.acme.com/v1/refunds
- List subscriptions: GET https://api.acme.com/v1/subscriptions
- Create webhook: POST https://api.acme.com/v1/webhooks

Das Parsen dieser Datei erfordert weniger als 800 Token. Ein LLM weiß jetzt, dass die Acme-API Zahlungen abwickelt, und hat 12 Endpunkte und können drei Links folgen, um tiefergehende Informationen zu erhalten.

2. Listen Sie Ihre Endpunkte mit Methoden und URLs auf

Listen Sie bei API-Produkten jeden Endpunkt mit seiner HTTP-Methode und der vollständigen URL auf. Das ist das Wertvollste Abschnitt zur Codegenerierung. Ein LLM, der es weiß POST https://api.acme.com/v1/charges Sie können einen funktionierenden Curl-Befehl oder SDK-Aufruf generieren, ohne Ihre vollständigen Dokumente lesen zu müssen.

3. Link zu maschinenlesbaren Spezifikationen

Wenn Sie eine OpenAPI-Spezifikation veröffentlichen, verlinken Sie sie in Ihrem llms.txt. LLMs können OpenAPI JSON analysieren und extrahieren Sie Parameterschemata, erforderliche Felder und Antworttypen. Das Gleiche gilt für MCP-Tool-Manifeste oder GraphQL-Introspektionsendpunkte.

4. Erstellen Sie llms-full.txt für tiefen Kontext

Nehmen Sie jeden Endpunkt aus Ihrer Zusammenfassung und erweitern Sie ihn mit Anfrage-/Antwortbeispielen:

# Botoi API - Full Documentation

&gt; Complete endpoint reference for all 150+ developer utility endpoints.

## IP Geolocation

POST https://api.botoi.com/v1/ip/lookup

Returns city, region, country, ISP, coordinates, and timezone for any IP address.

**Request:**
\`\`\`json
{ "ip": "8.8.8.8" }
\`\`\`

**Response:**
\`\`\`json
{
  "success": true,
  "data": {
    "ip": "8.8.8.8",
    "city": "Mountain View",
    "region": "California",
    "country": "US",
    "isp": "Google LLC",
    "lat": 37.386,
    "lon": -122.0838
  }
}
\`\`\`

## Email Validation

POST https://api.botoi.com/v1/email/validate
...full documentation for every endpoint

Beziehen Sie realistische Nutzlasten ein, keine Platzhalterdaten. Ein LLM, der Integrationscode generiert, muss sehen die genauen Feldnamen, Typen und Verschachtelungen, die Ihre API zurückgibt.

5. Servieren Sie mit den richtigen Headern

Beide Dateien mit bereitstellen text/markdown oder text/plain Inhaltstyp. Wenn Sie Verwenden Sie Nginx:

# Serve llms.txt with correct Content-Type
location = /llms.txt {
    default_type text/markdown;
    add_header X-Robots-Tag "noindex";
}

location = /llms-full.txt {
    default_type text/markdown;
    add_header X-Robots-Tag "noindex";
}

Legen Sie die Dateien auf Cloudflare Pages, Vercel oder Netlify in Ihrem ab public/ Verzeichnis. Die Hosting-Plattform stellt ihnen den richtigen MIME-Typ aus der Dateierweiterung bereit.

Echtes Beispiel: botois llms.txt

Botoi serviert llms.txt bei botoi.com/llms.txt Und llms-full.txt bei botoi.com/llms-full.txt. Hier ist eine komprimierte Ansicht der Zusammenfassungsdatei:

# Botoi - Developer Utility API &amp; MCP Server

&gt; One API key, 150+ developer utility endpoints, and a 49-tool
&gt; MCP server for AI agents. IP geolocation, email validation,
&gt; DNS, hashing, JWT, QR codes, PDF generation, and more.
&gt; Sub-50ms from Cloudflare's edge. Free tier included.

## Free Online Tools

- [JSON Formatter](https://botoi.com/tools/json-formatter): Format, beautify, minify, and validate JSON data
- [Base64 Encoder/Decoder](https://botoi.com/tools/base64-encoder-decoder): Encode and decode Base64 strings
- [Hash Generator](https://botoi.com/tools/hash-generator): Generate SHA-1, SHA-256, SHA-384, SHA-512 hashes

## Botoi API

- [API Documentation](https://api.botoi.com/docs): Full API reference with interactive playground
- [OpenAPI Spec](https://api.botoi.com/openapi.json): Machine-readable OpenAPI 3.1 specification
- [MCP Tool Manifest](https://api.botoi.com/v1/mcp/tools.json): MCP tool definitions for AI agents

## API Endpoints

- IP geolocation: POST https://api.botoi.com/v1/ip/lookup
- Email validation: POST https://api.botoi.com/v1/email/validate
- DNS lookup: POST https://api.botoi.com/v1/dns/lookup
- Hash generation: POST https://api.botoi.com/v1/hash
...150+ more endpoints listed with method and URL

Die vollständige Datei listet jedes Tool, alle über 150 API-Endpunkte mit Methoden und URLs sowie den MCP-Server auf Konfiguration für fünf AI-Editoren und den TypeScript SDK-Installationsbefehl. Ein LLM, der dies liest Datei kann antworten: „Wie validiere ich eine E-Mail mit botoi?“ ohne eine einzige Webseite zu besuchen.

Hol es dir selbst:

curl -s https://botoi.com/llms.txt | head -20

Generative Engine-Optimierung: über traditionelles SEO hinaus

Traditionelles SEO optimiert für den Crawler von Google. Die generative Motoroptimierung (GEO) optimiert für KI-Modelle, die Antworten aus mehreren Quellen synthetisieren. Wenn ein Entwickler ChatGPT fragt: „Welche API?“ Kann ich es zur E-Mail-Validierung verwenden?“ greift das Modell auf Quellen zurück, die es analysiert hat oder abrufen kann.

llms.txt ist ein Teil einer GEO-Strategie. Das Gesamtbild beinhaltet:

  • llms.txt Und llms-full.txt für den direkten LLM-Verbrauch.
  • OpenAPI-Spezifikation unter einer öffentlichen URL, damit LLMs Ihre Endpunktschemata analysieren können.
  • MCP-Servererkennung über /.well-known/mcp/server-card.json also KI Assistenten können Ihre Werkzeuge finden und eine Verbindung zu ihnen herstellen.
  • Strukturierte Daten (JSON-LD) auf Ihren Seiten für eine umfassendere Extraktion.
  • robots.txt so konfiguriert, dass KI-Crawler (GPTBot, ClaudeBot, PerplexityBot).

Jede Ebene zielt auf eine andere Art und Weise ab, wie LLMs Ihre API entdecken und nutzen. llms.txt ist Der Ausgangspunkt mit dem geringsten Aufwand und der größten Wirkung.

Checkliste für die Bereitstellung

1. Create /llms.txt with product name, description, and key links
2. Create /llms-full.txt with full endpoint documentation
3. Add both files to your robots.txt sitemap (optional)
4. Set Content-Type to text/markdown or text/plain
5. Keep llms.txt under 10KB and llms-full.txt under 100KB
6. Update both files whenever you ship new endpoints
7. Test: curl -s https://yourdomain.com/llms.txt | wc -c

Behalten Sie Ihre llms.txt in der Versionskontrolle neben Ihrem API-Quellcode. Aktualisieren Sie es in derselben Pull-Anfrage, in der Sie einen neuen Endpunkt hinzufügen. Veraltete Dokumentation, sei es für Menschen oder Maschinen, untergräbt das Vertrauen.

Wichtige Punkte

  • LLMs lesen Ihre Dokumente, bevor es Menschen tun. KI-Agenten, Programmierassistenten und Chat Schnittstellen analysieren die API-Dokumentation, um Code zu generieren und Fragen zu beantworten. Geben Sie ihnen ein sauberes Format.
  • Markdown kostet 6x weniger Token als HTML. Strip-Navigation, Skripte und Styling. Stellen Sie den Inhalt, den LLMs benötigen, in dem Format bereit, das sie am effizientesten verarbeiten können.
  • Zwei Dateien decken beide Anwendungsfälle ab. llms.txt ist der zusammenfassende Index. llms-full.txt ist die vollständige Referenz. Beginnen Sie mit der Zusammenfassung; Fügen Sie die Vollversion hinzu wenn Sie möchten, dass LLMs funktionierenden Integrationscode generieren.
  • Über 849 Websites haben das Format übernommen. Anthropic, Cloudflare, Stripe und Mintlify alle dienen llms.txt. Das Format gewinnt als GEO-Standard an Bedeutung.
  • Sehen Sie es in Aktion. Bringen botoi.com/llms.txt um eine über 150 Endpunkt-API anzuzeigen, die in einer einzigen Markdown-Datei beschrieben wird.

FAQ

Was ist llms.txt und wie funktioniert es?
llms.txt ist eine Markdown-Datei, die unter /llms.txt auf Ihrer Domain bereitgestellt wird. Es beschreibt Ihr Produkt, Ihre API-Endpunkte und Dokumentationslinks in einem strukturierten Format, das LLMs mit minimalen Tokens analysieren können. Betrachten Sie es als robots.txt für KI: robots.txt sagt Crawlern, was sie indizieren sollen, llms.txt teilt Sprachmodellen mit, was Ihre Website bietet.
Wie viele Token spart llms.txt im Vergleich zu HTML-Dokumenten?
Markdown verwendet etwa sechsmal weniger Token als gleichwertiger HTML-Inhalt. Eine Dokumentationsseite, die in HTML 12.000 Token kostet, kann in Markdown auf unter 2.000 Token komprimiert werden. Dies ist wichtig, da LLMs endliche Kontextfenster haben und jeder Token, der für die Formatierung ausgegeben wird, ein Token ist, der nicht für das Verständnis Ihrer API ausgegeben wird.
Benötige ich sowohl llms.txt als auch llms-full.txt?
llms.txt ist die Zusammenfassung: Produktname, Beschreibung und eine Liste mit Links. llms-full.txt enthält den vollständigen Dokumentationsinhalt, auf den die Links verweisen, eingebettet in einer einzigen Datei. Beginnen Sie mit llms.txt. Fügen Sie llms-full.txt hinzu, wenn Sie möchten, dass LLMs einen tiefen Kontext haben, ohne mehreren Links zu folgen.
Welche KI-Tools lesen heute llms.txt?
Claude, ChatGPT, Perplexity und Cursor lesen alle llms.txt, wenn sie Dokumentation durchsuchen oder darauf verweisen. MCP-basierte Agenten und Codierungsassistenten rufen es auch zur Tool-Erkennung ab. Über 849 Websites haben das Format Anfang 2026 übernommen, darunter Anthropic, Cloudflare, Mintlify und Stripe.
Wo soll ich die Datei llms.txt hosten?
Stellen Sie es im Stammverzeichnis Ihrer Domain bereit: https://yourdomain.com/llms.txt. Verwenden Sie text/markdown oder text/plain als Content-Type. Wenn Sie über eine API-Subdomäne verfügen, sollten Sie erwägen, diese sowohl in der Hauptdomäne als auch in der API-Subdomäne bereitzustellen. Halten Sie die Datei für die Zusammenfassungsversion unter 10 KB.

Starte mit botoi zu entwickeln

150+ API-Endpunkte für Abfragen, Textverarbeitung, Bildgenerierung und Entwickler-Tools. Kostenloser Tarif, keine Kreditkarte nötig.