WhatsApp Evolution
MCP Evolution API
A Model Context Protocol (MCP) server for Claude that integrates with Evolution API for WhatsApp automation.
Overview
This MCP server allows Claude to interact with WhatsApp through the Evolution API, enabling capabilities like:
- Managing WhatsApp instances
- Sending various types of messages
- Working with contacts and groups
- Configuring webhooks and settings
π Project Structure
mcp-evo-api/
βββ src/
β βββ tools/ # MCP tools implementation for Evolution API
β βββ utils/ # Shared utilities, including Evolution API client
β βββ main.ts # Server entry point
β βββ types.ts # Shared type definitions
βββ scripts/ # Helper scripts
βββ biome.json # Linting configuration
βββ tsconfig.json # TypeScript configuration
βββ docker-compose.yml # Docker Compose configuration
βββ Dockerfile # Docker build configuration
βββ package.json # Project dependencies
π Quick Setup
Environment Setup
Create a .env
file with your Evolution API credentials:
EVOLUTION_API_URL=https://your-evolution-api-server.com
EVOLUTION_API_KEY=your-api-key-here
π Deployment Options
Environment | Steps | Command |
---|---|---|
Local Development | 1. Clone and install2. Run in dev mode | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun install bun run dev |
Local Production | 1. Clone and install2. Build and run | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun install bun run build && bun run dist/main.js |
Docker Compose | Run with Docker Compose | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api docker-compose up -d |
Docker | Build and run container | docker run -d -p 3000:3000 -e EVOLUTION_API_URL=yoururl -e EVOLUTION_API_KEY=yourkey --name mcp-evo-api ghcr.io/aiteks-ltda/mcp-evo-api:latest |
Claude Desktop Configuration
Add this to your Claude Desktop config file (typically located at ~/Library/Application Support/Claude/claude_desktop_config.json
):
{
"mcpServers": {
"evo-api": {
"command": "node",
"args": [
"/path/to/your/mcp-evo-api/dist/main.js"
]
}
}
}
If using the Docker deployment:
{
"mcpServers": {
"evo-api": {
"url": "http://localhost:3000"
}
}
}
π Implementation Status
Category | Implemented | Pending Implementation |
---|---|---|
Core API | β Get Informationβ Create Instanceβ Fetch Instancesβ Instance Connectβ Restart Instanceβ Connection Stateβ Logout Instanceβ Delete Instanceβ Set Presence | β Check is WhatsApp |
Webhook & Settings | β Set Webhookβ Find Webhookβ Set Settingsβ Find Settings | |
Messaging | β Send Plain Textβ Send Statusβ Send Mediaβ Send WhatsApp Audioβ Send Stickerβ Send Locationβ Send Contactβ Send Reactionβ Send Pollβ Send Listβ Send Buttons | β Mark Message As Readβ Mark Message As Unreadβ Archive Chatβ Delete Message for Everyoneβ Update Messageβ Send Presence (Chat Ctrl) |
Chat & Contacts | β Find Contactsβ Find Chats | β Update Block Statusβ Fetch Profile Picture URLβ Get Base64β Find Messagesβ Find Status Message |
Groups | β Find Group by JIDβ Fetch All Groupsβ Find Group Members | β Create Groupβ Update Group Pictureβ Update Group Subjectβ Update Group Descriptionβ Fetch Invite Codeβ Revoke Invite Codeβ Send Group Inviteβ Find Group by Invite Codeβ Update Group Membersβ Update Group Settingβ Toggle Ephemeralβ Leave Group |
Profile Settings | β Fetch Business Profileβ Fetch Profileβ Update Profile Nameβ Update Profile Statusβ Update Profile Pictureβ Remove Profile Pictureβ Fetch Privacy Settingsβ Update Privacy Settings | |
Bot Integrations | β Typebot Integrationsβ OpenAI Integrationsβ Evolution Botβ Dify Botβ Flowise Bot | |
Other Integrations | β Chatwootβ Websocketβ SQSβ RabbitMQ |
For more information, refer to the Evolution API Documentation.