Guia
Documentação para IA e agentes
Dê ao ChatGPT, ao Claude, ao Cursor, ao Codex, ao Grok e a outras ferramentas de IA um contexto preciso sobre o Emailit com o llms.txt, páginas em Markdown, o servidor MCP e o plugin do Emailit.
Os assistentes de IA respondem melhor sobre o Emailit quando leem a documentação atual em vez de adivinhar. O Emailit oferece a eles três camadas de ajuda:
| Camada | O que ela dá ao assistente | Comece por aqui |
|---|---|---|
| Documentação em Markdown | Todas as páginas da documentação e as principais páginas do emailit.com em Markdown simples, além de índices llms.txt. | Esta página |
| Servidor MCP | 109 ferramentas que agem nos seus workspaces: enviar e-mails, configurar domínios, executar campanhas e mais. | Servidor MCP |
| Plugin e skills | Conhecimento do Emailit para Claude Code, Codex, Cursor e Grok Build: fluxos de configuração, verificações de entregabilidade, padrões de uso dos SDKs e manuseio seguro de chaves. | Plugins e skills |
Use só a documentação para responder perguntas e escrever código. Adicione o servidor MCP quando o assistente também precisar fazer o trabalho na sua conta.
Arquivos para ferramentas de IA
| Arquivo | O que contém | Para que usar |
|---|---|---|
https://emailit.com/llms.txt |
Um resumo curto do Emailit: produtos, preços, créditos por ação, o servidor MCP e links importantes. | Dar a um assistente uma visão geral rápida do que é o Emailit. |
https://emailit.com/llms-full.txt |
As principais páginas do emailit.com em um único arquivo: produtos, preços, créditos, programas, respostas e comparações. | Perguntas sobre planos, produtos, parceiros, indicações e como o Emailit se compara a outros serviços. |
https://emailit.com/docs/llms.txt |
Um índice de todas as páginas da documentação, agrupadas por seção, com um resumo de uma linha e um link para a versão em Markdown de cada uma. Ele também lista fatos importantes, como a URL base da API, as configurações de SMTP e a URL do servidor MCP. | Permitir que um assistente encontre e busque as páginas de que precisa. |
https://emailit.com/docs/llms-full.txt |
O texto completo de todas as páginas da documentação em um único arquivo. | Carregar toda a documentação em um projeto, em uma base de conhecimento ou no índice de documentação de um editor. |
Esses arquivos seguem a convenção llms.txt e são gerados de novo sempre que o site ou a documentação mudam.
Versão em Markdown de qualquer página
Adicione .md à URL de uma página, sem a barra final, para obtê-la em Markdown. Isso funciona para a documentação e para as principais páginas do emailit.com:
| Página | 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 |
Cada página HTML aponta para a versão em Markdown com <link rel="alternate" type="text/markdown">, para que agentes e crawlers a encontrem sem adivinhar a URL.
As partes interativas de uma página, como abas, destaques e tabelas de planos, viram Markdown simples, então os exemplos de código de todas as linguagens são incluídos. Na referência da API, cada recurso também tem um arquivo combinado com todos os endpoints dele, por exemplo, https://emailit.com/docs/api-reference/emails.md para a API de e-mails.
Ações da página
Toda página da documentação tem um botão Copiar página ao lado do título. Selecione-o para copiar a página em Markdown, pronta para colar em um chat. A seta ao lado dele abre mais opções:
| Ação | O que faz |
|---|---|
| Copiar como Markdown | Copia o Markdown da página para a sua área de transferência. |
| Ver como Markdown | Abre a versão .md em uma nova aba. |
| Abrir no ChatGPT | Inicia uma conversa no ChatGPT que pede a ele para ler o Markdown da página, para que você possa fazer perguntas sobre ela. |
| Abrir no Claude | Inicia uma conversa no Claude com o mesmo prompt. |
Usar a documentação nas suas ferramentas
- Assistentes de chat. Cole uma página com Copiar página ou peça ao assistente para ler uma URL
.md. Para perguntas amplas, indiquehttps://emailit.com/docs/llms.txte deixe que ele escolha as páginas. - Projetos e bases de conhecimento. Adicione
https://emailit.com/docs/llms-full.txtcomo fonte em um projeto do Claude, em um GPT personalizado ou no assistente interno da sua equipe. Atualize-o de tempos em tempos para incluir as mudanças. - Editores de código. Adicione
https://emailit.com/docs/llms-full.txt(ouhttps://emailit.com/docs/) como fonte de documentação no Cursor ou em um editor semelhante e faça referência a ela quando pedir código para o Emailit. - Agentes de programação. Instale o plugin do Emailit no Claude Code, no Codex, no Cursor ou no Grok Build. As skills dele só carregam as orientações de configuração e de SDK do Emailit quando uma tarefa precisa delas e indicam ao agente estas páginas em Markdown para os detalhes.
Para perguntas específicas, prefira o arquivo .md de uma única página: ele é menor que o arquivo completo e mantém o assistente no assunto.
Combinar a documentação com o servidor MCP
A documentação diz a um assistente como o Emailit funciona; o servidor MCP permite que ele aja no seu workspace. Juntos, eles permitem que um assistente leia as regras e depois faça o trabalho. Por exemplo, no Cursor, no Codex ou no Claude Code com o servidor MCP do Emailit conectado:
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.O assistente lê as regras de assinatura na documentação, chama create-webhook para configurar o endpoint e obter o segredo de assinatura e escreve um código compatível.
Dicas
- Confira a data. Cada página mostra quando foi atualizada pela última vez. Se a resposta de um assistente contradisser uma página, confie na página.
- Deixe os segredos fora dos prompts. A documentação nunca precisa da sua chave de API. Prefira OAuth para o servidor MCP e mantenha as chaves no seu ambiente, não em mensagens de chat nem em arquivos com commit.
- Informe as lacunas. Se um assistente não encontra algo na documentação, provavelmente isso também falta para as pessoas. Avise-nos em support@emailit.com.
Para crawlers e criadores de ferramentas
- O
robots.txtpermite mecanismos de busca e crawlers de IA, incluindo GPTBot, OAI-SearchBot, ChatGPT-User, ClaudeBot, Claude-User, PerplexityBot e Google-Extended. Apenas a API do painel e os caminhos de administração ficam excluídos. - As respostas em Markdown usam
text/markdown, e os arquivos llms.txt usamtext/plain. Todos são arquivos estáticos, armazenados em cache na edge. - As páginas trazem dados estruturados schema.org (
TechArticlepara a documentação, além de breadcrumbs), uma URL canônica e uma data de atualização. - O servidor MCP descreve cada ferramenta com um JSON schema, um título e anotações como somente leitura e destrutiva, e retorna resultados estruturados. Consulte a referência de ferramentas.