Email MCP Server by Sidemail

Permita que agentes de IA escrevam e gerenciem seus e-mails de SaaS

Documentação

Servidor MCP – Envie e gerencie e-mails, contatos e domínios de envio

O servidor MCP da Sidemail permite que você envie e gerencie programaticamente e-mails transacionais, contatos, domínios de envio, modelos, e-mails recebidos, configurações do projeto, logs de API e recursos do Messenger – diretamente do modo agente MCP no VS Code, Claude, Cursor e outros clientes MCP.

Sidemail MCP server

O que é MCP? O Model Context Protocol (MCP) é um novo padrão aberto que facilita a conexão de sistemas de IA com dados e serviços externos. O MCP funciona de forma semelhante a uma API para modelos de IA – ele fornece uma "linguagem" padrão para programas de IA acessarem ferramentas ou dados do mundo externo. Saiba mais em nosso artigo explicativo.

Recursos do servidor MCP

  • Gerenciar domínios de envio
  • Revisar e atualizar configurações do projeto
  • Testar o envio de e-mails transacionais
  • Gerenciar contatos e grupos
  • Criar, atualizar e excluir rascunhos do Messenger
  • Criar, atualizar e consultar modelos
  • Gerenciar rotas de entrada e inspecionar e-mails recebidos
  • Consultar e-mails enviados, contatos, modelos, logs de solicitações de API e estatísticas de logs
  • Validar endereços de e-mail, com validação SMTP profunda opcional

Pré-requisitos

  • Chave de API da Sidemail
  • Node.js v20 ou superior, apenas para a configuração local do pacote NPM

Configuração HTTP hospedada

Use o servidor MCP HTTP Streamable hospedado quando seu cliente suportar servidores MCP remotos:

https://api.sidemail.io/mcp

Envie sua chave de API da Sidemail no cabeçalho Authorization como um token Bearer.

{
    "servers": {
        "sidemail": {
            "type": "http",
            "url": "https://api.sidemail.io/mcp",
            "headers": {
                "Authorization": "Bearer ${input:sidemail-key}"
            }
        }
    },
    "inputs": [
        {
            "type": "promptString",
            "id": "sidemail-key",
            "description": "Sidemail API Key",
            "password": true
        }
    ]
}

Configuração local via NPM

Use o pacote NPM local quando seu cliente esperar um servidor MCP stdio.

Configuração no Microsoft VS Code (assistida)

  1. Abra a Paleta de Comandos (Ctrl/Cmd + Shift + P).
  2. Digite "MCP: Add Server…" e selecione.
  3. Selecione "NPM Package".
  4. Digite @sidemail/mcp e confirme.
  5. Confirme a instalação.
  6. Digite sua chave de API da Sidemail e confirme.

Configuração local no Microsoft VS Code (manual)

Alternativamente, você pode instalá-lo manualmente modificando o arquivo de configuração mcp.json.

  1. Abra a Paleta de Comandos (Ctrl/Cmd + Shift + P).
  2. Digite "MCP: Open User Configuration" e selecione.
  3. Adicione a configuração abaixo e salve as alterações.
{
    "servers": {
        "sidemail-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": ["-y", "@sidemail/mcp"],
            "env": {
                "SIDEMAIL_API_KEY": "${input:sidemail-key}"
            }
        }
    },
    "inputs": [
        {
            "type": "promptString",
            "id": "sidemail-key",
            "description": "Sidemail API Key",
            "password": true
        }
    ]
}

Configuração local no Claude Desktop

Edite (ou crie) o arquivo de configuração:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
{
    "mcpServers": {
        "sidemail": {
            "command": "npx",
            "args": ["-y", "@sidemail/mcp"],
            "env": { "SIDEMAIL_API_KEY": "your-key" }
        }
    }
}

Configuração no Cursor

Crie ou edite ~/.cursor/mcp.json:

{
    "mcpServers": {
        "sidemail": {
            "command": "npx",
            "args": ["-y", "@sidemail/mcp"],
            "env": { "SIDEMAIL_API_KEY": "your-key" }
        }
    }
}

Uso via CLI

npx @sidemail/mcp

Para testes HTTP locais:

MCP_TRANSPORT=http npx @sidemail/mcp

Ferramentas do servidor MCP

Domínios

  • list-domains: Listar todos os domínios de envio
  • create-domain: Adicionar um novo domínio de envio
  • check-domain: Verificar verificação de domínio e status de DNS
  • setup-domain-mail-from: Configurar registros DNS personalizados de Mail-From
  • delete-domain: Remover um domínio de envio

Exemplo – Adicionando um novo domínio de envio: Sidemail Email MCP server – Adding a new sending domain via AI tool

Projetos

  • get-project: Obter o projeto atual
  • create-linked-project: Criar um projeto vinculado
  • update-project: Atualizar configurações do projeto e design de e-mail
  • delete-linked-project: Excluir o projeto vinculado atual

Messenger

  • list-messenger-drafts: Listar rascunhos do Messenger
  • get-messenger-draft: Obter rascunho do Messenger por ID
  • create-messenger-draft: Criar um rascunho do Messenger
  • update-messenger-draft: Atualizar um rascunho do Messenger
  • delete-messenger-draft: Excluir um rascunho do Messenger

Exemplo – Escrevendo um e-mail de atualização de produto: Sidemail Email MCP server – Writing a product update email via AI tool

Grupos

  • list-groups: Listar todos os grupos de contatos
  • create-group: Criar um novo grupo de contatos
  • update-group: Atualizar um grupo de contatos
  • delete-group: Excluir um grupo de contatos

Contatos

  • create-or-update-contact: Criar ou atualizar um contato
  • list-contacts: Listar contatos com paginação
  • query-contacts: Consultar contatos com filtros
  • clean-contacts-batch: Validar e limpar contatos em um grupo
  • find-contact: Encontrar um contato por e-mail
  • delete-contact: Excluir um contato

E-mails

  • send-email: Enviar um e-mail transacional
  • query-emails: Consultar e-mails enviados
  • get-email: Recuperar um e-mail por ID
  • delete-email: Excluir um e-mail agendado

Validação de e-mail

  • validate-email: Validar um endereço de e-mail. Use isDeep: true para validação de caixa de correio SMTP; verificações profundas podem consumir créditos de validação.

Modelos

Para a estrutura de elementos content e exemplos de modelos, consulte a documentação de nós de conteúdo da API de Modelos. Os agentes também podem inspecionar a saída de list-template-gallery ou get-template antes de criar atualizações complexas de modelos.

  • list-templates: Listar modelos de e-mail
  • get-template: Recuperar um modelo por ID
  • create-template: Criar um modelo de e-mail
  • update-template: Atualizar um modelo de e-mail
  • list-template-gallery: Listar modelos da galeria
  • list-template-fonts: Listar fontes de modelo suportadas

E-mails recebidos

  • list-inbound-routes: Listar rotas de entrada
  • create-inbound-route: Criar uma rota de entrada
  • update-inbound-route: Atualizar uma rota de entrada
  • delete-inbound-route: Excluir uma rota de entrada
  • list-received-emails: Listar e-mails recebidos
  • get-received-email: Recuperar um e-mail recebido por ID

Logs de API

  • query-api-request-logs: Consultar logs recentes de solicitações de API
  • get-api-request-log-stats: Obter estatísticas de logs de solicitações de API

Mais recursos