Průvodce
Dokumentace pro AI a agenty
Dejte ChatGPT, Claude, Cursoru, Codexu, Groku a dalším AI nástrojům přesný kontext o Emailitu přes llms.txt, stránky v Markdownu, MCP server a plugin Emailit.
AI asistenti odpovídají na otázky o Emailitu lépe, když čtou aktuální dokumentaci, místo aby hádali. Emailit jim pomáhá na třech úrovních:
| Úroveň | Co asistentovi dává | Kde začít |
|---|---|---|
| Dokumentace v Markdownu | Každou stránku dokumentace a hlavní stránky emailit.com jako prostý Markdown a k tomu rejstříky llms.txt. | Tato stránka |
| MCP server | 109 nástrojů, které pracují s vašimi workspace: odesílají e-maily, nastavují domény, spouštějí kampaně a další. | MCP server |
| Plugin a dovednosti | Know-how o Emailitu pro Claude Code, Codex, Cursor a Grok Build: postupy nastavení, kontroly doručitelnosti, vzory pro SDK a bezpečné zacházení s klíči. | Pluginy a dovednosti |
Samotnou dokumentaci používejte k odpovídání na otázky a psaní kódu. MCP server přidejte, když má asistent práci ve vašem účtu také provést.
Soubory pro AI nástroje
| Soubor | Co obsahuje | K čemu slouží |
|---|---|---|
https://emailit.com/llms.txt |
Krátké shrnutí Emailitu: produkty, ceny, kredity za jednotlivé akce, MCP server a důležité odkazy. | Rychlý přehled pro asistenta, co je Emailit. |
https://emailit.com/llms-full.txt |
Hlavní stránky emailit.com v jednom souboru: produkty, ceny, kredity, programy, odpovědi a srovnání. | Otázky na tarify, produkty, partnery, doporučení a srovnání Emailitu s jinými službami. |
https://emailit.com/docs/llms.txt |
Rejstřík všech stránek dokumentace seskupený podle sekcí, u každé s jednořádkovým shrnutím a odkazem na verzi v Markdownu. Uvádí také klíčové údaje, jako je základní URL API, nastavení SMTP a URL MCP serveru. | Aby si asistent našel a stáhl stránky, které potřebuje. |
https://emailit.com/docs/llms-full.txt |
Plné znění všech stránek dokumentace v jednom souboru. | Načtení celé dokumentace do projektu, znalostní báze nebo rejstříku dokumentace v editoru. |
Tyto soubory dodržují konvenci llms.txt a sestavují se znovu při každé změně webu nebo dokumentace.
Verze libovolné stránky v Markdownu
Když k URL stránky přidáte .md (bez koncového lomítka), dostanete stránku v Markdownu. Funguje to pro dokumentaci i pro hlavní stránky emailit.com:
| Stránka | 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 |
Každá stránka v HTML odkazuje na svou verzi v Markdownu pomocí <link rel="alternate" type="text/markdown">, takže ji agenti a crawlery najdou, aniž by museli hádat URL.
Interaktivní části stránky, jako jsou karty, zvýrazněné bloky a tabulky tarifů, se převedou na prostý Markdown, takže verze v Markdownu obsahuje ukázky kódu pro všechny jazyky. V referenci API má navíc každý zdroj jeden společný soubor se všemi svými endpointy, například https://emailit.com/docs/api-reference/emails.md pro API e-mailů.
Akce se stránkou
Každá stránka dokumentace má vedle nadpisu tlačítko Kopírovat stránku. Když ho vyberete, zkopíruje se stránka jako Markdown připravený k vložení do chatu. Šipka vedle tlačítka otevře další možnosti:
| Akce | Co dělá |
|---|---|
| Kopírovat jako Markdown | Zkopíruje Markdown stránky do schránky. |
| Zobrazit jako Markdown | Otevře verzi .md na nové kartě. |
| Otevřít v ChatGPT | Zahájí konverzaci v ChatGPT s výzvou, aby si přečetl Markdown stránky, takže se na ni pak můžete ptát. |
| Otevřít v Claude | Zahájí konverzaci v aplikaci Claude se stejnou výzvou. |
Používejte dokumentaci ve svých nástrojích
- Chatovací asistenti. Vložte stránku pomocí tlačítka Kopírovat stránku, nebo asistenta požádejte, ať si přečte URL
.md. U obecných otázek ho nasměrujte nahttps://emailit.com/docs/llms.txta nechte ho vybrat stránky. - Projekty a znalostní báze. Přidejte
https://emailit.com/docs/llms-full.txtjako zdroj do projektu v Claude, vlastního GPT nebo interního asistenta vašeho týmu. Čas od času zdroj obnovte, aby obsahoval změny. - Editory kódu. Přidejte
https://emailit.com/docs/llms-full.txt(nebohttps://emailit.com/docs/) jako zdroj dokumentace v Cursoru nebo podobném editoru a pak se na něj odvolávejte, když budete chtít kód pro Emailit. - Programovací agenti. Nainstalujte plugin Emailit do Claude Code, Codexu, Cursoru nebo Grok Build. Jeho dovednosti načtou postupy nastavení Emailitu a rady k SDK, jen když je úkol potřebuje, a pro podrobnosti agenta nasměrují na tyto stránky v Markdownu.
Pro cílené otázky dávejte přednost souboru .md jedné stránky: je menší než celý soubor a udrží asistenta u tématu.
Kombinujte dokumentaci s MCP serverem
Dokumentace asistentovi říká, jak Emailit funguje; MCP server mu umožní pracovat s vaším workspace. Dohromady si asistent může přečíst pravidla a pak práci rovnou udělat. Například v Cursoru, Codexu nebo Claude Code s připojeným MCP serverem Emailitu:
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.Asistent si z dokumentace přečte pravidla podepisování, zavolá create-webhook, aby nastavil endpoint a získal tajný klíč webhooku, a napíše kód, který jim odpovídá.
Tipy
- Zkontrolujte datum. Každá stránka ukazuje, kdy byla naposledy aktualizována. Pokud je odpověď asistenta v rozporu se stránkou, věřte stránce.
- Nevkládejte tajné údaje do promptů. Dokumentace váš API klíč nikdy nepotřebuje. U MCP serveru dávejte přednost OAuth a klíče uchovávejte v prostředí, ne ve zprávách v chatu ani v commitnutých souborech.
- Nahlaste, co chybí. Pokud asistent něco v dokumentaci nenajde, pravděpodobně to chybí i lidem. Napište nám na support@emailit.com.
Pro crawlery a tvůrce nástrojů
robots.txtpovoluje vyhledávače i AI crawlery, mimo jiné GPTBot, OAI-SearchBot, ChatGPT-User, ClaudeBot, Claude-User, PerplexityBot a Google-Extended. Vyloučené jsou jen cesty API webového rozhraní a administrace.- Odpovědi v Markdownu používají
text/markdowna soubory llms.txttext/plain. Všechny jsou statické soubory uložené v mezipaměti na edge serverech. - Stránky obsahují strukturovaná data schema.org (
TechArticlepro dokumentaci a k tomu drobečkovou navigaci), kanonickou URL a datum aktualizace. - MCP server popisuje každý nástroj schématem JSON, názvem a anotacemi, například jen pro čtení nebo destruktivní, a vrací strukturované výsledky. Viz Reference nástrojů.