Leitfaden
Doku für KI und Agenten
Geben Sie ChatGPT, Claude, Cursor, Codex, Grok und anderen KI-Tools präzisen Kontext zu Emailit, mit llms.txt, Markdown-Seiten, dem MCP-Server und dem Emailit-Plugin.
KI-Assistenten beantworten Fragen zu Emailit besser, wenn sie die aktuelle Doku lesen, statt zu raten. Emailit unterstützt sie auf drei Ebenen:
| Ebene | Was der Assistent bekommt | Einstieg |
|---|---|---|
| Doku als Markdown | Jede Doku-Seite und die wichtigsten Seiten von emailit.com als reines Markdown, dazu llms.txt-Indizes. | Diese Seite |
| MCP-Server | 109 Tools, die in Ihren Workspaces handeln: E-Mails senden, Domains einrichten, Kampagnen durchführen und mehr. | MCP-Server |
| Plugin und Skills | Emailit-Know-how für Claude Code, Codex, Cursor und Grok Build: Einrichtungsabläufe, Zustellbarkeitsprüfungen, SDK-Muster und sicherer Umgang mit Schlüsseln. | Plugins und Skills |
Nutzen Sie die Doku allein, um Fragen zu beantworten und Code zu schreiben. Nehmen Sie den MCP-Server hinzu, wenn der Assistent die Arbeit auch in Ihrem Konto erledigen soll.
Dateien für KI-Tools
| Datei | Inhalt | Geeignet für |
|---|---|---|
https://emailit.com/llms.txt |
Eine kurze Zusammenfassung von Emailit: Produkte, Preise, Credits pro Aktion, der MCP-Server und wichtige Links. | Einem Assistenten einen schnellen Überblick geben, was Emailit ist. |
https://emailit.com/llms-full.txt |
Die wichtigsten Seiten von emailit.com in einer Datei: Produkte, Preise, Credits, Programme, Antworten und Vergleiche. | Fragen zu Tarifen, Produkten, Partnern, Empfehlungen und dazu, wie Emailit im Vergleich abschneidet. |
https://emailit.com/docs/llms.txt |
Ein Index aller Doku-Seiten, nach Bereichen gruppiert, mit einer einzeiligen Zusammenfassung und einem Link zur Markdown-Version. Er listet außerdem wichtige Fakten wie die Basis-URL der API, die SMTP-Einstellungen und die URL des MCP-Servers. | Einen Assistenten die benötigten Seiten finden und abrufen lassen. |
https://emailit.com/docs/llms-full.txt |
Der vollständige Text aller Doku-Seiten in einer Datei. | Die gesamte Doku in ein Projekt, eine Wissensdatenbank oder den Doku-Index eines Editors laden. |
Diese Dateien folgen der Konvention llms.txt und werden bei jeder Änderung der Website oder der Doku neu erstellt.
Markdown-Version jeder Seite
Hängen Sie .md an die URL einer Seite an, ohne den abschließenden Schrägstrich, um sie als Markdown zu erhalten. Das funktioniert für die Doku und für die wichtigsten Seiten von emailit.com:
| Seite | Markdown |
|---|---|
https://emailit.com/docs/quickstart/api/ |
https://emailit.com/docs/quickstart/api.md |
https://emailit.com/docs/webhooks/request-signature/ |
https://emailit.com/docs/webhooks/request-signature.md |
https://emailit.com/docs/mcp/tools/ |
https://emailit.com/docs/mcp/tools.md |
https://emailit.com/pricing/ |
https://emailit.com/pricing.md |
https://emailit.com/products/email-api/ |
https://emailit.com/products/email-api.md |
https://emailit.com/vs/sendgrid/ |
https://emailit.com/vs/sendgrid.md |
https://emailit.com/ |
https://emailit.com/index.md |
Jede HTML-Seite verweist mit <link rel="alternate" type="text/markdown"> auf ihre Markdown-Version, damit Agenten und Crawler sie finden, ohne die URL zu erraten.
Interaktive Teile einer Seite wie Tabs, Callouts und Tariftabellen werden zu reinem Markdown, sodass die Codebeispiele für alle Sprachen enthalten sind. Für die API-Referenz gibt es pro Ressource außerdem eine kombinierte Datei mit allen Endpunkten, zum Beispiel https://emailit.com/docs/api-reference/emails.md für die Ressource E-Mails.
Seitenaktionen
Jede Doku-Seite hat neben dem Titel die Schaltfläche Seite kopieren. Wählen Sie sie, um die Seite als Markdown zu kopieren, bereit zum Einfügen in einen Chat. Der Pfeil daneben öffnet weitere Optionen:
| Aktion | Was sie bewirkt |
|---|---|
| Als Markdown kopieren | Kopiert das Markdown der Seite in Ihre Zwischenablage. |
| Als Markdown anzeigen | Öffnet die .md-Version in einem neuen Tab. |
| In ChatGPT öffnen | Startet eine ChatGPT-Unterhaltung, die ChatGPT auffordert, das Markdown der Seite zu lesen, damit Sie Fragen dazu stellen können. |
| In Claude öffnen | Startet eine Claude-Unterhaltung mit demselben Prompt. |
Doku in Ihren Tools nutzen
- Chat-Assistenten. Fügen Sie eine Seite mit Seite kopieren ein oder lassen Sie den Assistenten eine
.md-URL lesen. Bei allgemeinen Fragen verweisen Sie ihn aufhttps://emailit.com/docs/llms.txtund lassen ihn die Seiten auswählen. - Projekte und Wissensdatenbanken. Fügen Sie
https://emailit.com/docs/llms-full.txtals Quelle in einem Claude-Projekt, einem eigenen GPT oder dem internen Assistenten Ihres Teams hinzu. Aktualisieren Sie die Quelle von Zeit zu Zeit, um Änderungen zu übernehmen. - Code-Editoren. Fügen Sie
https://emailit.com/docs/llms-full.txt(oderhttps://emailit.com/docs/) in Cursor oder einem ähnlichen Editor als Dokumentationsquelle hinzu und verweisen Sie darauf, wenn Sie Emailit-Code anfordern. - Coding-Agenten. Installieren Sie das Emailit-Plugin in Claude Code, Codex, Cursor oder Grok Build. Seine Skills laden Hinweise zur Emailit-Einrichtung und zu den SDKs nur, wenn eine Aufgabe sie braucht, und verweisen den Agenten für Details auf diese Markdown-Seiten.
Nehmen Sie für gezielte Fragen lieber die .md-Datei einer einzelnen Seite: Sie ist kleiner als die vollständige Datei und hält den Assistenten beim Thema.
Doku mit dem MCP-Server kombinieren
Die Doku erklärt einem Assistenten, wie Emailit funktioniert; der MCP-Server lässt ihn in Ihrem Workspace handeln. Zusammen kann ein Assistent die Regeln lesen und dann die Arbeit erledigen. Zum Beispiel in Cursor, Codex oder Claude Code mit verbundenem Emailit-MCP-Server:
Read https://emailit.com/docs/webhooks/request-signature.md and
https://emailit.com/docs/webhooks/event-types.md.
Then create an Emailit webhook named "Bounces" that sends email.bounced
and email.complained events to https://acme.com/webhooks/emailit, and
add an Express route at /webhooks/emailit that verifies the signature
with the webhook's secret and marks bounced addresses in our users table.Der Assistent liest die Signaturregeln aus der Doku, ruft create-webhook auf, um den Endpunkt einzurichten und das Signatur-Secret zu erhalten, und schreibt passenden Code.
Tipps
- Datum prüfen. Jede Seite zeigt, wann sie zuletzt aktualisiert wurde. Wenn die Antwort eines Assistenten einer Seite widerspricht, vertrauen Sie der Seite.
- Secrets aus Prompts heraushalten. Die Doku braucht nie Ihren API-Schlüssel. Verwenden Sie für den MCP-Server bevorzugt OAuth und bewahren Sie Schlüssel in Ihrer Umgebung auf, nicht in Chatnachrichten oder eingecheckten Dateien.
- Lücken melden. Wenn ein Assistent etwas nicht in der Doku findet, fehlt es wahrscheinlich auch für Menschen. Schreiben Sie uns an support@emailit.com.
Für Crawler und Tool-Entwickler
robots.txterlaubt Suchmaschinen und KI-Crawler, darunter GPTBot, OAI-SearchBot, ChatGPT-User, ClaudeBot, Claude-User, PerplexityBot und Google-Extended. Ausgeschlossen sind nur die API der Weboberfläche und die Admin-Pfade.- Markdown-Antworten verwenden
text/markdown, die llms.txt-Dateientext/plain. Alle sind statische Dateien, die am Edge gecacht werden. - Seiten enthalten strukturierte Daten nach schema.org (
TechArticlefür die Doku, dazu Breadcrumbs), eine kanonische URL und ein Aktualisierungsdatum. - Der MCP-Server beschreibt jedes Tool mit einem JSON-Schema, einem Titel und Annotationen wie read-only und destructive und gibt strukturierte Ergebnisse zurück. Siehe die Tool-Referenz.