@marcelocorrea/mcp-evolution-api
v1.0.3
Published
MCP Server para integração com Evolution API WhatsApp
Maintainers
Readme
MCP Evolution API
Servidor MCP (Model Context Protocol) para integração com a Evolution API - WhatsApp Business API.
📋 Características
Este servidor MCP fornece ferramentas para interagir com a Evolution API, permitindo:
Gerenciamento de Instâncias
- ✅ Criar, conectar, reiniciar e deletar instâncias
- ✅ Verificar status de conexão
- ✅ Logout de instâncias
Mensagens
- ✅ Enviar mensagens de texto
- ✅ Enviar mídias (imagem, vídeo, documento)
- ✅ Enviar contatos
- ✅ Enviar localização
- ✅ Enviar botões interativos
- ✅ Enviar enquetes
- ✅ Enviar stickers
- ✅ Deletar mensagens
Chat
- ✅ Verificar números do WhatsApp
- ✅ Buscar contatos
- ✅ Buscar mensagens
- ✅ Buscar conversas
- ✅ Marcar mensagens como lidas
- ✅ Arquivar conversas
Grupos
- ✅ Criar grupos
- ✅ Atualizar nome e descrição
- ✅ Gerenciar códigos de convite
- ✅ Atualizar foto do grupo
Perfil
- ✅ Atualizar nome do perfil
- ✅ Atualizar status
- ✅ Atualizar foto de perfil
- ✅ Gerenciar configurações de privacidade
🚀 Instalação
# Instalar dependências
npm install
# Compilar o projeto
npm run build⚙️ Configuração
- Copie o arquivo
.env.examplepara.env:
cp .env.example .env- Configure as variáveis de ambiente:
EVOLUTION_API_URL=http://localhost:8080
EVOLUTION_API_KEY=sua-chave-api-aqui
EVOLUTION_INSTANCE_NAME=minha-instancia🔧 Uso
Desenvolvimento
npm run devProdução
npm start🔌 Configuração no Claude Desktop
Adicione ao seu arquivo de configuração do Claude Desktop (claude_desktop_config.json):
MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Usando NPX (Recomendado)
{
"mcpServers": {
"evolution-api": {
"command": "npx",
"args": ["-y", "@marcelocorrea/mcp-evolution-api"],
"env": {
"EVOLUTION_API_URL": "http://localhost:8080",
"EVOLUTION_API_KEY": "sua-chave-api",
"EVOLUTION_INSTANCE_NAME": "minha-instancia"
}
}
}
}Usando caminho local
{
"mcpServers": {
"evolution-api": {
"command": "node",
"args": ["/caminho/completo/para/mcp-evolution-api/dist/index.js"],
"env": {
"EVOLUTION_API_URL": "http://localhost:8080",
"EVOLUTION_API_KEY": "sua-chave-api",
"EVOLUTION_INSTANCE_NAME": "minha-instancia"
}
}
}
}📚 Ferramentas Disponíveis
Instâncias
create_instance- Criar nova instânciafetch_instances- Listar instânciasconnect_instance- Conectar e obter QR Codeget_connection_status- Status da conexãorestart_instance- Reiniciar instâncialogout_instance- Deslogardelete_instance- Deletar instância
Mensagens
send_text- Enviar textosend_media- Enviar mídiasend_contact- Enviar contatosend_location- Enviar localizaçãosend_buttons- Enviar botõessend_poll- Enviar enquetesend_sticker- Enviar sticker
Chat
check_whatsapp_numbers- Verificar númerosfind_contacts- Buscar contatosfind_messages- Buscar mensagensfind_chats- Buscar conversasdelete_message- Deletar mensagem
Grupos
create_group- Criar grupoupdate_group_subject- Atualizar nomefetch_invite_code- Obter código de convite
Perfil
update_profile_name- Atualizar nomeupdate_profile_status- Atualizar statusfetch_privacy_settings- Buscar configurações de privacidade
Configurações
set_settings- Configurar instânciafind_settings- Buscar configurações
📝 Exemplos de Uso
Enviar mensagem de texto
{
"number": "5511999999999",
"text": "Olá! Esta é uma mensagem de teste."
}Criar grupo
{
"subject": "Meu Grupo",
"description": "Descrição do grupo",
"participants": ["5511999999999", "5511888888888"]
}Enviar mídia
{
"number": "5511999999999",
"mediatype": "image",
"media": "https://exemplo.com/imagem.jpg",
"caption": "Legenda da imagem"
}🛠️ Tecnologias
- TypeScript - Linguagem principal
- Model Context Protocol SDK - Framework MCP
- Axios - Cliente HTTP
- Zod - Validação de schemas
📄 Licença
MIT
🤝 Contribuindo
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests.
