Woodpecker

Gerencie campanhas de e-mail no Woodpecker usando linguagem natural.

Documentação

Servidor MCP Woodpecker

A integração Woodpecker MCP (Model Context Protocol) transforma o gerenciamento de campanhas de e-mail frio em uma experiência conversacional.

Ao conectar seu assistente de IA à poderosa plataforma de automação da Woodpecker, você pode criar, gerenciar e otimizar campanhas de e-mail por meio de interações em linguagem natural.

Comece com comandos simples, como listar campanhas e criar sequências básicas de divulgação. Em seguida, explore gradualmente recursos avançados, como testes A/B, sequências complexas de acompanhamento e relatórios analíticos detalhados.

Recursos

  • Gerenciamento de Campanhas: Criar, atualizar, executar, pausar e excluir campanhas de e-mail
  • Operações com Prospects: Adicionar prospects à sua conta e campanhas, atualizar e excluir dados de prospects, pesquisar prospects
  • Composição de E-mail: Criar sequências de e-mail em várias etapas com recursos de teste A/B
  • Análises e Relatórios: Recuperar estatísticas de campanha e métricas de desempenho
  • Integração de Caixa de Entrada: Atribuir contas de e-mail a campanhas
  • Configuração Avançada: Suporte a agendamentos de envio, configurações de fuso horário e conformidade com GDPR

Instalação

Pré-requisitos

Antes de configurar a integração, certifique-se de ter:

  • Conta Woodpecker: Uma conta com o complemento API & Integration habilitado
  • Credenciais de API: Chave de API da Woodpecker (encontrada nas configurações da sua conta)
  • Docker: Instalado no seu sistema (para executar o servidor MCP) https://docs.docker.com/desktop/
  • Agente de IA: Claude Desktop, Continue.dev ou outra plataforma de IA compatível com MCP

Obtendo sua Chave de API da Woodpecker

  1. Faça login na conta Woodpecker (https://login.woodpecker.co/)
  2. Vá para o Marketplace no canto superior direito → Integrações → 'Chaves de API'
  3. Clique em Create a key

Configuração do Agente de IA

Claude Desktop

Passo 1: Localize o Arquivo de Configuração

Encontre o arquivo de configuração do Claude Desktop:

macOS:

~/Library/Application Support/Claude/claude_desktop_config.json

Windows:

%APPDATA%\Claude\claude_desktop_config.json

Linux:

~/.config/Claude/claude_desktop_config.json
Passo 2: Adicione a Configuração do Servidor MCP

Edite o arquivo de configuração para incluir o servidor MCP Woodpecker:

{
    "mcpServers": {
        "woodpecker": {
            "command": "docker",
            "args": [
                "run",
                "-i",
                "--rm",
                "-e",
                "WOODPECKER_API_KEY",
                "woodpeckerco/woodpecker-mcp-server"
            ],
            "env": {
                "WOODPECKER_API_KEY": "<YOUR_API_KEY>"
            }
        }
    }
}
Passo 3: Reinicie o Claude Desktop
  1. Saia completamente do Claude Desktop
  2. Reinicie o aplicativo
  3. Procure pelas ferramentas Woodpecker na interface

Outros Agentes Compatíveis com MCP

Para outras plataformas de IA que suportam MCP:

  1. Garanta o Suporte a MCP: Verifique se seu agente de IA suporta o Model Context Protocol
  2. Autenticação: Forneça as credenciais da API Woodpecker (WOODPECKER_API_KEY) por meio de variáveis de ambiente
  3. Protocolo: Use o transporte stdio conforme suportado pelo seu agente

Verificação e Testes

No seu agente de IA, tente perguntar:

"What Woodpecker tools do you have access to?"
"List my Woodpecker campaigns"

Solução de Problemas

Servidor MCP Não Está Conectando

Sintomas: O agente de IA não consegue acessar as ferramentas Woodpecker

Soluções:

  1. Tente o caminho absoluto do Docker (por exemplo, /usr/local/bin/docker) na Configuração do Servidor MCP
  2. Verifique se o contêiner Docker está em execução: docker ps
  3. Teste a chave de API: Faça uma chamada direta à API Woodpecker

Credenciais de API Inválidas

Sintomas: Erros "Não autorizado" ou "Chave de API inválida"

Soluções:

  1. Regere a chave de API nas configurações da Woodpecker
  2. Atualize as variáveis de ambiente com a nova chave
  3. Reinicie o aplicativo do agente de IA

Ferramentas Indisponíveis

Sintomas: O agente de IA não vê as funções Woodpecker

Soluções:

  1. Verifique a configuração do servidor MCP no agente de IA
  2. Reinicie o aplicativo do agente de IA
  3. Verifique os logs do agente de IA para erros de conexão MCP

Falha na Criação de Campanha

Sintomas: Erro ao criar campanhas

Soluções:

  1. Certifique-se de ter pelo menos uma conta de e-mail configurada na Woodpecker
  2. Verifique os IDs das contas de e-mail com a função listMailboxes
  3. Verifique se os parâmetros da campanha correspondem ao formato exigido
  4. Certifique-se de que o limite diário de inscrição seja > 0

Exemplos de Uso

Criando Sua Primeira Campanha

"Create a new email campaign with these details:
- Name: Product Demo Outreach
- Subject: Quick demo of our new feature
- Message: Hi {{FIRST_NAME}}, I'd love to show {{COMPANY}} our new feature. Are you available for a 15-minute demo?
- Send Monday-Friday, 9 AM to 5 PM
- Daily limit: 25 prospects
- Use my main email account"

Adicionando Prospects em Massa

"Add these prospects to campaign 12345:
1. John Doe, john@example.com, Example Corp, Marketing Director
2. Jane Smith, jane@example.com, Tech Solutions, CEO
3. Bob Johnson, bob@example.com, Startup Inc, CTO

Use this personalization for each:
- John: 'I saw your recent blog post about email marketing'
- Jane: 'Congratulations on your recent funding round'
- Bob: 'Your product launch looked impressive'"

Gerenciamento de Campanhas

"Pause campaign 12345 and show me its performance statistics"
"Update campaign 'Product Demo Outreach' to send only 15 prospects per day"
"Add a follow-up email to campaign 12345 that sends 3 days after the first email"

Análises e Relatórios

"Show me statistics for all my running campaigns"
"Which campaign has the highest open rate?"
"Create a summary report of my campaign performance this month"

Melhores Práticas

Gerenciamento de Campanhas

  1. Comece Pequeno: Teste com 5 a 10 prospects antes de escalar
  2. Monitore o Desempenho: Verifique as estatísticas regularmente
  3. Respeite os Limites: Mantenha-se dentro dos limites diários de inscrição
  4. Teste A/B: Use várias versões de e-mail para otimização

Dados de Prospects

  1. Qualidade dos Dados: Certifique-se de que os endereços de e-mail sejam válidos
  2. Personalização: Use trechos significativos e campos personalizados
  3. Segmentação: Organize prospects com tags e setores
  4. Conformidade: Inclua links de cancelamento de inscrição e respeite as exclusões

Interações com o Agente de IA

  1. Seja Específico: Forneça instruções claras para a criação de campanhas
  2. Verifique os Resultados: Confira os detalhes da campanha antes de executar
  3. Use Exemplos: Inclua conteúdo de exemplo e personalização
  4. Monitore a Automação: Revise campanhas geradas por IA antes da implantação

Suporte

Entre em contato com a Equipe de Suporte Woodpecker em Suporte Woodpecker

Licença

É concedida permissão para usar esta imagem Docker para fins pessoais e comerciais. Redistribuição, modificação e engenharia reversa são proibidas. Nenhuma garantia é fornecida.

Copyright 2025 Woodpecker.co S.A.

Ferramentas Disponíveis

Gerenciamento de Campanhas

createCampaign

Crie campanhas com configuração básica, incluindo assuntos, mensagens e configurações de envio. Suporta modelagem completa com trechos, fallbacks e spintax para conteúdo personalizado.

Parâmetros:

  • name (string): Nome da campanha
  • subjects (array): Linhas de assunto do e-mail
  • messages (array): Conteúdo do corpo do e-mail
  • emailAccountIds (array): IDs das contas SMTP
  • timezone (string): Fuso horário da campanha
  • dailyEnroll (number): Limite diário de inscrição de prospects
  • deliveryDays (array): Dias da semana para envio
  • deliveryTimeStart/Stop (string): Janela de horário de envio
  • trackOpens (boolean): Habilitar rastreamento de abertura

createAdvancedCampaign

Crie campanhas com recursos completos de API, incluindo testes A/B e agendamentos de envio complexos.

Parâmetros:

  • campaignPayload (string): JSON completo de configuração da campanha

listCampaigns

Recupere campanhas com filtro opcional por status.

Parâmetros:

  • pageNumber (number): Número da página (baseado em 1)
  • statuses (array): Filtrar por status (RUNNING, DRAFT, PAUSED, STOPPED, COMPLETED)

retrieveCampaignDetails

Obtenha a estrutura detalhada da campanha, incluindo todas as etapas e configurações.

Parâmetros:

  • campaignId (number): ID da campanha

retrieveCampaignStatistics

Busque métricas de desempenho e análises da campanha.

Parâmetros:

  • campaignId (number): ID da campanha

updateCampaignSettings

Modifique configurações gerais da campanha, incluindo nome, contas de e-mail, limites diários e fuso horário.

Parâmetros:

  • campaignId (number): ID da campanha
  • name (string): Nome da campanha
  • emailAccountIds (array): Lista de IDs de contas de e-mail
  • timezone (string): Fuso horário da campanha
  • dailyEnroll (number): Limite diário de inscrição

buildCampaignUrl

Gere a URL do aplicativo Woodpecker para acesso à campanha.

Parâmetros:

  • campaignId (number): ID da campanha

Controle de Campanha

  • runCampaign(campaignId): Iniciar execução da campanha
  • pauseCampaign(campaignId): Pausar campanha
  • stopCampaign(campaignId): Parar campanha
  • deleteCampaign(campaignId): Remover campanha completamente
  • makeCampaignEditable(campaignId): Habilitar modificações na campanha

Gerenciamento de Etapas de E-mail

addStep

Adicione etapas de acompanhamento a campanhas existentes.

Parâmetros:

  • campaignId (number): ID da campanha
  • payload (string): JSON de configuração da etapa

updateCampaignStep

Modifique horários de envio e agendamento das etapas.

Parâmetros:

  • campaignId (number): ID da campanha
  • stepId (string): ID da etapa
  • payload (string): Configuração de envio atualizada

updateStepVersion

Atualize o conteúdo do e-mail, linhas de assunto, assinaturas e configurações de rastreamento.

Parâmetros:

  • campaignId (number): ID da campanha
  • stepId (string): ID da etapa
  • versionId (string): ID da versão
  • subject (string): Assunto do e-mail
  • message (string): Corpo do e-mail (HTML suportado)
  • signature (string): SENDER ou NO_SIGNATURE
  • trackOpens (boolean): Habilitar rastreamento de abertura

deleteCampaignStep

Remova etapas de campanhas.

Parâmetros:

  • campaignId (number): ID da campanha
  • stepId (string): ID da etapa

Operações com Prospects

addProspectsToDatabase

Adiciona novos prospects à sua lista global de prospects sem inscrevê-los em nenhuma campanha.

Parâmetros:

  • prospectsPayload (string): Matriz JSON de dados de prospects

Notas:

  • Os prospects são adicionados à sua conta, mas não a nenhuma campanha
  • Disponíveis para inscrição futura em campanhas
  • Útil para construir um banco de dados de prospects antes da criação de campanhas

addProspectsToCampaign

Adicione prospects em massa com informações de contato completas e trechos personalizados.

Parâmetros:

  • campaignId (number): ID da campanha
  • prospectsPayload (string): Matriz de objetos de prospects

Nota: Sempre verifique se há prospects DUPLICATE na resposta. Use updateProspectsInCampaign para duplicatas se forem necessárias atualizações de dados.

updateProspectsInDatabase

Atualiza prospects existentes no seu banco de dados global ou adiciona novos se eles não existirem.

Parâmetros:

  • prospectsPayload (string): Matriz JSON de dados de prospects com atualizações

Notas:

  • Prospects existentes são atualizados com base no endereço de e-mail
  • Novos prospects são adicionados se o e-mail não existir
  • Inclua apenas os campos que deseja atualizar
  • As atualizações se aplicam globalmente (afetam todas as campanhas que usam esses prospects)

updateProspectsInCampaign

Atualize dados de prospects existentes (requer solicitação explícita do usuário).

Parâmetros:

  • campaignId (number): ID da campanha
  • prospectsPayload (string): Matriz de objetos de prospects com atualizações

listProspectsInDatabase

Lista prospects do seu banco de dados global de prospects (não vinculado a nenhuma campanha específica).

Parâmetros:

  • pageNumber (integer): Número da página (indexação baseada em 1)

Notas:

  • Retorna resultados paginados de todos os prospects da sua conta
  • Esses prospects podem ser adicionados a qualquer campanha
  • Útil para gerenciar seu banco de dados geral de prospects

listProspectsInCampaign

Recuperação paginada de prospects da campanha.

Parâmetros:

  • campaignId (number): ID da campanha
  • pageNumber (number): Número da página (baseado em 1)

searchProspects

Pesquisa prospects que correspondem a critérios específicos em todo o seu banco de dados.

Parâmetros:

  • pageNumber (integer): Número da página (indexação baseada em 1)
  • searchCriteria (object, opcional): Objeto JSON com parâmetros de pesquisa
  • filterCriteria (object, opcional): Objeto JSON com filtros adicionais

Campos de pesquisa disponíveis:

  • email - Endereço de e-mail
  • first_name - Primeiro nome
  • last_name - Sobrenome
  • company - Nome da empresa
  • organization_id - ID da organização
  • industry - Setor
  • website - URL do site
  • tags - Tags (sensível a maiúsculas/minúsculas, sem # inicial)
  • title - Cargo
  • phone - Número de telefone
  • address - Endereço
  • city - Cidade
  • state - Estado/Província
  • country - País
  • snippet1 a snippet15 - Campos personalizados

Campos de filtro disponíveis:

  • id - Lista separada por vírgulas de IDs de prospects
  • status - Status global do prospect: ACTIVE, BOUNCED, REPLIED, BLACKLIST, INVALID
  • campaigns_id - Lista separada por vírgulas de IDs de campanhas nas quais os prospects estão inscritos
  • contacted - Se um prospect já foi contatado
  • interested - Nível de interesse: INTERESTED, MAYBE-LATER, NOT-INTERESTED, NOT-MARKED

Notas:

  • A pesquisa por tags é sensível a maiúsculas/minúsculas, não use # inicial ao pesquisar por tags
  • Os critérios de pesquisa usam OR para o mesmo campo e AND para campos diferentes
  • Para filtrar prospects OPT-OUT, use o status "BLACKLIST"
  • Vários valores de filtro são separados por vírgulas

deleteProspects

Exclui permanentemente prospects do seu banco de dados e/ou de campanhas específicas. Parâmetros:

  • prospectIds (string): Lista separada por vírgulas de IDs de prospects para excluir
  • campaignIds (string, opcional): Lista separada por vírgulas de IDs de campanhas das quais remover prospects

Observações:

  • Sem campaignIds: Exclui prospects globalmente de todo o seu banco de dados
  • Com campaignIds: Remove prospects apenas de campanhas especificadas
  • Esta ação é permanente e não pode ser desfeita
  • Requer confirmação explícita do usuário antes da execução
  • Use IDs de prospects (não endereços de e-mail) obtidos em operações de listagem/busca

Aviso: A exclusão global remove prospects de todas as campanhas e do seu banco de dados. A exclusão local (com campaignIds) remove apenas das campanhas especificadas, mantendo-os no seu banco de dados global.

Gerenciamento de Contas

listMailboxes

Recupere contas de e-mail disponíveis para atribuição de campanhas.

Parâmetros: Nenhum

Histórico de Alterações

v0.0.9 (2025-07-28)

  • Melhorias internas e correções de bugs

v0.0.8 (2025-06-24)

  • Adicionadas ferramentas de lista global de prospects

v0.0.7 (2025-06-11)

  • Lançamento inicial com ferramentas relacionadas a campanhas

Documentação