Lumail MCP

Automatize seu email marketing com lumail (workflow, assinantes e assim por diante)

Documentação

O servidor MCP (Model Context Protocol) do Lumail permite que um assistente de IA leia e gerencie assinantes, campanhas, Workflows, tags, segmentos, configurações e análises com escopo organizacional.

O catálogo de ferramentas é gerado a partir das mesmas definições usadas pelo agente integrado do Lumail, CLI, SDK e API de Ferramentas. Use a descoberta de ferramentas MCP como fonte da verdade em vez de depender de um número fixo de ferramentas.

Escolha um endpoint

ClienteEndpointAutenticaçãoPerfil de segurança
ChatGPT e Codexhttps://lumail.io/mcpLumail OAuthCatálogo selecionado de leitura e rascunho-escrita
Claude, Cursor e clientes MCP confiáveishttps://lumail.io/api/mcp/sseToken de API da organizaçãoCatálogo completo de ferramentas da organização com portões de confirmação

O endpoint OAuth não pode enviar, publicar, agendar, excluir, arquivar ou cancelar inscrição. Siga o guia para ChatGPT e Codex para essa configuração.

O endpoint de token de API é destinado a clientes confiáveis que precisam do catálogo mais amplo. Cada solicitação permanece limitada à organização proprietária do token.

Conecte-se com um token de API

Crie um token em Configurações → Tokens de API e adicione o endpoint HTTP Streamable ao seu cliente:

{
  "mcpServers": {
    "lumail": {
      "url": "https://lumail.io/api/mcp/sse",
      "headers": {
        "Authorization": "Bearer lum_your_api_token_here"
      }
    }
  }
}

Para um cliente somente stdio, use uma ponte HTTP:

{
  "mcpServers": {
    "lumail": {
      "command": "pnpm",
      "args": [
        "dlx",
        "mcp-remote",
        "https://lumail.io/api/mcp/sse",
        "--header",
        "Authorization: Bearer lum_your_api_token_here"
      ]
    }
  }
}

Reinicie o cliente MCP após alterar sua configuração.

Descubra recursos

Após a autenticação, o servidor anuncia o recurso MCP resources. Use resources/list e resources/read para recuperar:

  • Início para desenvolvedores e agentes do Lumail (https://lumail.io/, text/markdown) - capacidades concisas do produto e links canônicos de MCP, REST, SDK, CLI, suporte e documentação
  • Especificação OpenAPI 3.1 do Lumail (https://lumail.io/openapi.json, application/json) - operações REST tipadas, autenticação bearer, esquemas de solicitação, esquemas de resposta e erros estruturados

Cada URI retornado também resolve por HTTPS comum. O conteúdo dos recursos é documentação pública para desenvolvedores; os dados da organização permanecem disponíveis apenas por meio de ferramentas autenticadas.

Descubra ferramentas dinamicamente

Os clientes MCP recebem os nomes atuais das ferramentas, descrições, esquemas de entrada e anotações de segurança durante a descoberta. O mesmo catálogo está disponível via REST:

curl https://lumail.io/api/v2/tools \
  -H "Authorization: Bearer lum_your_api_token_here"

O v2 em /api/v2/tools é a versão da API de Ferramentas. Os nomes das ferramentas de Workflow são canônicos e sem versão.

Ferramentas canônicas de Workflow

O Lumail possui um mecanismo de Workflow baseado em grafo com suporte. Suas ferramentas MCP operam em rascunhos editáveis, versões publicadas imutáveis, execuções de assinantes, metas, saídas e grupos de exclusão mútua.

ÁreaFerramentas
Ler e criarlist_workflows, get_workflow, create_workflow
Grafo de rascunhoconfigure_workflow_draft, update_workflow_draft
Ciclo de vidapublish_workflow, update_workflow_status, delete_workflow
Inscriçãoadd_subscriber_to_workflow, add_subscribers_to_workflow, remove_subscriber_from_workflow
Execuçõesget_subscriber_workflow_runs, fast_forward_workflow_subscriber
Gruposlist_workflow_groups, get_workflow_group, create_workflow_group, update_workflow_group, set_workflow_group, delete_workflow_group

Não há ferramentas de Workflow com sufixo de versão e nenhuma ferramenta de mutação passo a passo. Um rascunho de Workflow é configurado como um grafo { steps, edges } completo.

Fluxo seguro de rascunho

  1. Chame get_skill com { "type": "workflow" }.
  2. Use list_workflows ou create_workflow para identificar o alvo.
  3. Chame get_workflow imediatamente antes de editar e mantenha seu updatedAt exato.
  4. Resolva tags, remetentes, snippets, campanhas, campos, metas e grupos referenciados com ferramentas de leitura.
  5. Chame configure_workflow_draft uma vez com as etapas e arestas completas, além de expectedUpdatedAt.
  6. Leia o Workflow novamente, inspecione cada e-mail interno configurado com get_campaign e verifique cada renderização com render_campaign.

configure_workflow_draft cria ou atualiza a campanha interna WORKFLOW pertencente a cada etapa EMAIL. Não chame create_campaign para e-mails de Workflow e não anexe campanhas de transmissão diretamente.

A configuração de rascunho nunca publica ou envia. Publicação e ativação são ações separadas, com portão de confirmação.

Categorias de ferramentas

O catálogo completo também inclui ferramentas para:

  • Assinantes, filtros compostos, tags e campos personalizados
  • Rascunho de campanhas, renderização, histórico, agendamento e análises
  • Segmentos e análises da organização
  • Remetentes de e-mail, domínios, entregabilidade e gerenciamento de supressão
  • Snippets, variáveis, imagens, importações e exportações
  • Recuperação de e-mail transacional e conteúdo web

Use get_skill antes de operações especializadas, como configuração de grafo de Workflow ou redação de e-mails. Passe { "type": "docs" } para listar todas as páginas de documentação do produto e depois { "type": "docs", "page": "<slug>" } para ler uma. Use o esquema retornado pela descoberta em vez de adivinhar nomes de parâmetros.

Portões de confirmação

Ferramentas de alto impacto usam um fluxo de confirmação em duas chamadas. A primeira chamada retorna CONFIRMATION_REQUIRED com um confirmationCode de cinco dígitos. Mostre a ação proposta ao usuário e repita exatamente a mesma chamada de ferramenta com esse código em até cinco minutos.

Ações com portão de confirmação incluem envio ou agendamento de e-mail, publicação ou ativação de Workflow, exclusão destrutiva, arquivamento e operações de cancelamento de inscrição. As anotações da ferramenta e a primeira resposta são autoritativas para o catálogo atual.

Os códigos são de uso único, expiram após cinco minutos e estão vinculados à organização, à ferramenta e à entrada exata.

Regras operacionais

  • Leia o recurso atual imediatamente antes de alterá-lo.
  • Crie campanhas e Workflows como rascunhos primeiro.
  • Nunca envie, publique, ative, agende, arquive, cancele inscrição ou exclua sem intenção explícita do usuário.
  • Preserve os valores de updatedAt para operações de concorrência otimista.
  • Use edit_campaign para alterações de campanha e configure_workflow_draft para grafos completos de Workflow.
  • Leia novamente cada mutação antes de relatar sucesso.
  • Mantenha os tokens de API em segredo e fora do código do lado do navegador, logs e prompts.
  • Respeite os limites de taxa da organização e repita as respostas 429 com backoff.

Exemplos de prompts

Create a welcome Workflow draft with three emails over seven days.
Keep it unpublished, then show me the rendered text and links for every email.
List my paused Workflows and explain which published version each one uses.
Do not activate anything.
Add the subscriber alex@example.com to the active onboarding Workflow.
Show me the exact action before requesting confirmation.

Solução de problemas

As ferramentas não aparecem: reinicie o cliente MCP, verifique o endpoint e confirme que o token pertence à organização pretendida.

Não autorizado: crie um novo token de API da organização ou reconecte a integração OAuth.

Workflow alterado desde a leitura: chame get_workflow novamente, mescle intencionalmente e tente novamente com o novo updatedAt.

Confirmação necessária: repita a mesma chamada com o código retornado. Alterar outra entrada cria um desafio de confirmação diferente.

Relacionados