Agentenbereite Dokumentation
Jede Typemark-Website stellt Markdown, llms.txt und einen MCP-Server bereit, damit KI-Tools Ihre Dokumentation lesen können, genauso wie Menschen.
Aktualisiert am 19. Nov. 20263 Min. Lesezeit
Ihre Leser fragen zunehmend einen KI-Assistenten, bevor sie Ihre Dokumentation öffnen. Jede Typemark-Website ist dafür eingerichtet, in jedem Tarif, ohne dass Sie etwas konfigurieren müssen: Jede Seite hat eine Markdown-Version, die Website hat llms.txt und llms-full.txt, und ein MCP-Server ermöglicht es Coding-Tools, Ihre Dokumentation direkt zu durchsuchen und zu lesen.
Private Dokumentation ist die Ausnahme: KI-Tools können sich nicht anmelden, daher hat eine passwortgeschützte Website keinen MCP-Server, und ihre Markdown-Seiten und llms.txt benötigen wie alles andere das Passwort.
Die Beispiele unten verwenden https://docs.acme.com. Ersetzen Sie das durch die Adresse Ihrer Website: Ihre eigene Domain oder {slug}.typemark.dev.
Markdown-Version jeder Seite
Hängen Sie .md an eine beliebige Seiten-URL an, um sie als Markdown zu erhalten:
curl https://docs.acme.com/guides/authentication.md
Sie erhalten den Seitentitel als Überschrift, die Beschreibung als Zitat und den Seiteninhalt ohne Frontmatter. Komponenten wie <Callout> bleiben unverändert, und Links verweisen auf vollständige URLs Ihrer Website.
Tools, die Accept: text/markdown senden, erhalten Markdown über die normale Seiten-URL. Jede HTML-Seite verweist außerdem mit einem Link-Header auf ihre Markdown-Version.
llms.txt und llms-full.txt
| Datei | Inhalt |
|---|---|
/llms.txt | Der Name und die Zusammenfassung Ihrer Website, danach eine Liste aller Seiten mit einem Link zu ihrer Markdown-Version und ihrer Beschreibung. Folgt dem llms.txt-Format. |
/llms-full.txt | Das Markdown aller Seiten in einer Datei, in Navigationsreihenfolge. |
Die Zusammenfassungszeile stammt aus seo.default_description in typemark.json. Seiten mit hidden: true in ihrem Frontmatter werden in beiden Dateien ausgelassen.
Diese Dateien können bis zu einer Stunde zwischengespeichert werden, daher kann es etwas dauern, bis eine Änderung sichtbar wird.
MCP-Server
Jede Website stellt unter /mcp einen schreibgeschützten MCP-Server bereit. Fügen Sie ihn einem KI-Tool hinzu, und das Tool kann während seiner Arbeit Ihre Dokumentation durchsuchen und lesen. Es ist keine Anmeldung und kein API-Schlüssel nötig.
https://docs.acme.com/mcp
Er stellt drei Tools bereit:
| Tool | Funktion |
|---|---|
search_docs | Durchsucht Ihre Dokumentation und gibt bis zu 10 passende Seiten mit jeweils einem Ausschnitt zurück |
get_page | Gibt eine Seite als Markdown zurück, per Pfad oder URL |
list_pages | Listet alle Seiten in Navigationsreihenfolge mit Pfad und Beschreibung auf |
Tools verbinden
Fügen Sie dies in ~/.cursor/mcp.json ein, oder in .cursor/mcp.json in einem Projekt:
{
"mcpServers": {
"acme-docs": {
"url": "https://docs.acme.com/mcp"
}
}
}Leser müssen diese Konfiguration nicht selbst schreiben. Mit Cursor / VS Code / Claude verbinden im Seiten-Aktionsmenü zeigt diese Snippets mit der URL Ihrer Website bereits ausgefüllt.
Limits
Jede IP-Adresse kann 60 MCP-Anfragen pro Minute stellen, und jede Website beantwortet bis zu 600 pro Minute.
Seiten-Aktionen
Jede veröffentlichte Seite hat neben ihrem Titel eine Schaltfläche Seite kopieren mit einem Menü für KI-Aktionen:
| Aktion | Funktion |
|---|---|
| Seite kopieren | Kopiert die Seite als Markdown, bereit zum Einfügen in einen Chat |
| Als Markdown anzeigen | Öffnet die .md-Version der Seite |
| In ChatGPT öffnen | Startet einen ChatGPT-Chat, der die Seite liest |
| In Claude öffnen | Startet einen Claude-Chat, der die Seite liest |
| Mit Cursor / VS Code / Claude verbinden | Zeigt die MCP-Einrichtung für Ihre Website |
Eine Karte Diese Dokumentation mit KI nutzen unter dem Inhaltsverzeichnis bietet Über MCP verbinden und llms.txt-Link kopieren an.
Seiten-Aktionen sind standardmäßig aktiviert. Um die Schaltfläche, das Menü und die Karte auszublenden, deaktivieren Sie Seiten-Aktionen unter Einstellungen > Leserfunktionen oder setzen Sie dies in typemark.json:
"features": {
"page_actions": false
}
Das Deaktivieren der Seiten-Aktionen blendet sie nur für Leser aus. Die Markdown-Seiten, llms.txt und der MCP-Server bleiben verfügbar.
Was Agenten sehen
KI-Tools erhalten genau das, was Leser erhalten:
- Nur veröffentlichte Inhalte. Im Modus manuelle Bereitstellung bleiben unveröffentlichte Änderungen aus Markdown-Seiten,
llms.txtund MCP heraus. - Nichts bei Offline-Betrieb. Wenn Ihre Website offline ist, liefern diese Oberflächen keine Inhalte aus.
- Versteckte Seiten bleiben unaufgelistet. Seiten mit
hidden: truewerden ausllms.txt,llms-full.txtsowie der Suche und Seitenliste des MCP-Servers ausgelassen. Ihre Markdown-Version ist mitnoindexmarkiert. - Die Standardsprache. Auf einer Website in mehreren Sprachen liefern
llms.txt,llms-full.txtund der MCP-Server die Standardsprache aus. - Keine Vorschauen. Vorschau-Deployments und Branch-Vorschauen haben keine Markdown-Seiten,
llms.txtoder MCP-Server.