
mcp evolution whatsapp api
MCP server for evolution, the non official api for whatsapp
Repository Info
About This Server
MCP server for evolution, the non official api for whatsapp
Model Context Protocol (MCP) - This server can be integrated with AI applications to provide additional context and capabilities, enabling enhanced AI interactions and functionality.
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://your-evolution-api-server.com
EVOLUTION_API_KEY=your-api-key-here
📋 Deployment Options
| Environment | Steps | Command |
|---|---|---|
| Local Development | 1. Clone and install 2. Run in dev mode | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun installbun run dev |
| Local Production | 1. Clone and install 2. Build and run | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun installbun 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-apidocker-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.
Quick Start
Clone the repository
git clone https://github.com/aiteks-ltda/mcp-evolution-whatsapp-apiInstall dependencies
cd mcp-evolution-whatsapp-api
npm installFollow the documentation
Check the repository's README.md file for specific installation and usage instructions.
Repository Details
Recommended MCP Servers
Discord MCP
Enable AI assistants to seamlessly interact with Discord servers, channels, and messages.
Knit MCP
Connect AI agents to 200+ SaaS applications and automate workflows.
Apify MCP Server
Deploy and interact with Apify actors for web scraping and data extraction.
BrowserStack MCP
BrowserStack MCP Server for automated testing across multiple browsers.
Zapier MCP
A Zapier server that provides automation capabilities for various apps.