Conectar o GitHub Copilot à Postal
Use a Postal no GitHub Copilot: no VS Code por OAuth, no Copilot CLI e no agente de nuvem do Copilot com uma chave de API.
- Como entra
- Conta ou chave
- Transporte
- HTTP
- Acessos recomendados
- Leitura e envio
Antes de começar
Confira estes pontos antes de abrir a configuração do GitHub Copilot. Eles evitam a maior parte das falhas de conexão.
- Time com o recurso de plano "Servidor MCP" (
mcp_access); sem ele o servidor responde 403plan_limit_reached. - Para enviar e-mails é preciso ter ao menos um domínio verificado no time.
- Se for usar chave de API: crie a chave no painel, em Chaves de API. Ela começa com
ps_; uma chave só de envio basta para quem só vai enviar. - Cada conexão age em um único time. Para usar outro time, conecte de novo escolhendo o outro.
- As conexões ficam em Configurações › Conexões de IA no painel, onde podem ser revogadas a qualquer momento.
O que o GitHub Copilot exige
VS Code 1.99 ou posterior com Copilot Chat em modo Agent (Visual Studio 17.14+, JetBrains, Xcode e Eclipse usam um mcp.json com "url" e cabeçalhos). Em organizações Copilot Business/Enterprise a política "MCP servers in Copilot" vem desativada: um administrador precisa ativá-la. O agente de nuvem só usa ferramentas (não recursos nem prompts) e não suporta OAuth remoto.
Conectar
Siga os passos na ordem. O endereço do servidor é sempre https://api.postal.so/mcp. Caminho recomendado: entrar com a sua conta (OAuth). A chave de API é a alternativa. Onde aparece ps_..., use a sua chave de API: o valor mostrado é só um exemplo.
- 1
VS Code (Copilot Chat): crie
.vscode/mcp.jsonno projeto (ou rode o comando "MCP: Add Server" e escolha HTTP) com o primeiro bloco. - 2
Clique em Start sobre o servidor no arquivo; o VS Code abre o login OAuth da Postal. Escolha o time e clique em Permitir.
- 3
No Copilot Chat, selecione o modo Agent e confira a lista de ferramentas (MCP: List Servers).
- 4
Com chave de API no VS Code, use o segundo bloco: o VS Code pergunta a chave ao iniciar o servidor.
- 5
Copilot CLI: rode o comando do terceiro trecho. Agente de nuvem do Copilot (GitHub): em Settings > Copilot > MCP servers do repositório, cole o JSON do quarto trecho e crie o segredo (ou variável)
COPILOT_MCP_POSTAL_API_KEYnas configurações de Agents do repositório (só nomes que começam com COPILOT_MCP_ ficam disponíveis); esse agente não suporta servidores remotos com OAuth.
VS Code (OAuth)
{
"servers": {
"postal": {
"type": "http",
"url": "https://api.postal.so/mcp"
}
}
}VS Code (chave de API)
{
"inputs": [
{
"type": "promptString",
"id": "postal-api-key",
"description": "Postal API key",
"password": true
}
],
"servers": {
"postal": {
"type": "http",
"url": "https://api.postal.so/mcp",
"headers": {
"Authorization": "Bearer ${input:postal-api-key}"
}
}
}
}Copilot CLI (chave de API)
copilot mcp add --transport http --header "Authorization: Bearer ps_..." postal https://api.postal.so/mcpAgente de nuvem do Copilot (chave de API)
{
"mcpServers": {
"postal": {
"type": "http",
"url": "https://api.postal.so/mcp",
"tools": [
"list_domains",
"get_domain",
"list_emails",
"get_email",
"get_usage"
],
"headers": {
"Authorization": "Bearer $COPILOT_MCP_POSTAL_API_KEY"
}
}
}
}Acessos que a ferramenta precisa
A Postal separa o acesso em três níveis, explicados na tabela de escopos. Para o GitHub Copilot:
mcp:readVer e-mails, domínios, contatos, segmentos, tópicos, templates, broadcasts, automações, formulários, conversas das inboxes, métricas e uso.
mcp:sendEnviar e agendar e-mails de domínios verificados e registrar eventos para automações.
mcp:fullTudo dos anteriores, mais criar, alterar e apagar contatos e templates, criar e enviar broadcasts (send_broadcast exige confirm: true), cancelar e-mails agendados e trabalhar nas inboxes (organizar, responder, criar rascunho).
No VS Code o Copilot pede os escopos que a Postal anuncia (os três). Para o agente de nuvem, que usa chave de API, prefira uma chave full_access com a lista tools restrita às ferramentas de leitura (o agente de nuvem usa as ferramentas sem pedir aprovação) ou uma chave sending_access se ele só precisa enviar e-mails de teste.
Como confirmar que funcionou
A prova mais simples é pedir algo de leitura dentro do próprio GitHub Copilot. A conexão também aparece em Configurações › Conexões de IA, no painel da Postal, com o app, o time e a última utilização.
Exemplo ilustrativo
Para quem quer a prova técnica
npx @modelcontextprotocol/inspector --cli https://api.postal.so/mcp \
--transport http \
--header "Authorization: Bearer ps_..." \
--method tools/listO Inspector prova que o servidor da Postal responde. Ele não testa o GitHub Copilot em si. O passo a passo completo está em Valide a conexão.
Se der problema
Percorra a lista na ordem. Depois, leia o que sabemos (e o que não sabemos) sobre o GitHub Copilot.
Confira
- O endereço é exatamente
https://api.postal.so/mcp, com/mcpno fim. - O tipo de conexão é HTTP (Streamable HTTP). A Postal não oferece SSE: se a ferramenta der a escolha, use HTTP.
- O time tem o recurso "Servidor MCP" no plano. Sem ele, o servidor responde 403
plan_limit_reached. - Para enviar e-mails, o time tem ao menos um domínio verificado.
- Cada conexão age em um único time. Para usar outro, conecte de novo e escolha o outro.
- Resposta 429 (
rate_limit_exceeded): o limite de requisições por segundo do plano foi atingido. Espere um pouco e tente de novo. - Se a ferramenta reclamar do tamanho da resposta, peça listas menores (no máximo 100 itens por chamada; o padrão é 20).
- Para recomeçar do zero, revogue a conexão em Configurações › Conexões de IA e conecte de novo.
O que foi testado e o que não foi
Rodamos testes automatizados da Postal com os documentos e os endereços de retorno reais que o app publica, e com o cliente oficial do SDK do MCP. Não é um teste dentro do aplicativo de verdade. Abaixo, a nota completa do que foi e do que não foi verificado.
Detalhe do teste
Verificado por teste (VS Code): o documento de metadados real do VS Code (https://vscode.dev/oauth/client-metadata.json, que lista também o grant device_code) é aceito, com os redirecionamentos http://127.0.0.1:33418 e https://vscode.dev/redirect; antes de 2026-10-28 esse documento era recusado por causa do grant device_code (correção feita). Chave de API em cabeçalho verificada com o SDK e o Inspector (Copilot CLI e agente de nuvem usam o mesmo caminho). O JSON do agente de nuvem foi montado a partir das regras da documentação do GitHub (a página não traz um exemplo com segredo em header) e o VS Code com inputs segue a documentação do VS Code; nenhum dos dois foi executado no produto real.
Perguntas frequentes
Preciso de uma chave de API para conectar o GitHub Copilot?
Não é obrigatório. O GitHub Copilot pode entrar com a sua conta da Postal (OAuth) ou com uma chave de API. Caminho recomendado: entrar com a sua conta (OAuth). A chave de API é a alternativa. A chave só de envio (sending_access) expõe apenas send_email e track_event.
Posso limitar o que o GitHub Copilot faz na minha conta?
No VS Code o Copilot pede os escopos que a Postal anuncia (os três). Para o agente de nuvem, que usa chave de API, prefira uma chave full_access com a lista tools restrita às ferramentas de leitura (o agente de nuvem usa as ferramentas sem pedir aprovação) ou uma chave sending_access se ele só precisa enviar e-mails de teste. Você pode revogar a conexão a qualquer momento em Configurações › Conexões de IA.
Continue por aqui
Outras ferramentas
Cada ferramenta tem o seu passo a passo. Veja também a lista completa em IA.
Gemini
Conecte a Postal ao Gemini CLI (e ao Antigravity, que o substitui para quem não tem plano pago) para consultar e enviar e-mails pelo terminal.
Ver como conectarv0
Conecte a Postal ao v0 para que ele consulte seus domínios e templates e envie e-mails de teste enquanto gera o app.
Ver como conectarBolt
Adicione a Postal como conector personalizado do Bolt para consultar e enviar e-mails enquanto você constrói o projeto.
Ver como conectarPronto para usar a Postal no GitHub Copilot?
Crie a sua conta e conecte. Se precisar de ajuda, fale com a gente pelo formulário de contato.