mcp-evolution-whatsapp-api
MCP server for evolution, the non official api for whatsapp
Documentation
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://evo-api.decisao.ai/
EVOLUTION_API_KEY=REPLACE_WITH_YOUR_REAL_KEYNote: you provided the API URL and a key. For security, never commit real API keys to the repository or share them publicly. Use a local `.env` file or a secrets manager in production.
📋 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.
Examples
- `examples/hono-bun/` - pequeno servidor Hono para Bun (exemplo salvo). Veja `examples/hono-bun/README.md` para instruções de execução.
Frequently asked questions
What is mcp-evolution-whatsapp-api?
mcp-evolution-whatsapp-api is MCP server for evolution, the non official api for whatsapp
How do I install mcp-evolution-whatsapp-api?
Open the GitHub repository and follow its README. Most MCP servers are added to your client's MCP config, then called by your agent.
Is mcp-evolution-whatsapp-api open source?
Yes — it is hosted on GitHub at https://github.com/aiteks-ltda/mcp-evolution-whatsapp-api and has 20 stars.
Related MCP tools
Playwright MCP server TypeScript-based implementation. Trusted by 22000+ developers. Trusted by 22000+ developers. Trusted by 22000+ developers.
Official Notion MCP Server TypeScript-based implementation. Trusted by 3400+ developers. Trusted by 3400+ developers. Trusted by 3400+ developers.
Directory for Awesome MCP Servers TypeScript-based implementation. Trusted by 1900+ developers. Trusted by 1900+ developers.
🧩 MCP Gateway - A lightweight gateway service that instantly transforms existing MCP Servers and APIs into MCP servers with zero code changes.
MCP Aggregator, Orchestrator, Middleware, Gateway in one docker TypeScript-based implementation. Trusted by 1400+ developers.
MCP Server for kubernetes management commands TypeScript-based implementation. Trusted by 1100+ developers. Trusted by 1100+ developers.
Run your own MCP server? See who uses it and what to fix.
Measure it with TrackMCP