MCP Evolution API
@genera-ai
MCP server for evolution api, the non official api for whatsapp
Overview
What is MCP Evolution API?
MCP Evolution API is a Model Context Protocol server that integrates with Evolution API for WhatsApp. It enables language models to manage WhatsApp instances, send text messages, obtain QR codes for connection, and check instance status.
How to use MCP Evolution API?
Configure environment variables (EVOLUTION_API_URL, EVOLUTION_API_KEY, PORT, API_KEY) in a .env file. Run locally with npm run dev or in production with npm run build then npm start. Deploy via Docker using docker run -d -p 3000:3000 ... or Docker Compose. Use the exposed tools through HTTP endpoints authenticated with a X-API-Key header.
Key features of MCP Evolution API
- Create new WhatsApp instances via Evolution API
- List all available WhatsApp instances
- Retrieve QR code for instance connection
- Send text messages to WhatsApp contacts
- All endpoints protected by API key authentication
Use cases of MCP Evolution API
- Automate WhatsApp messaging from an AI assistant
- Manage multiple WhatsApp instances programmatically
- Connect new WhatsApp devices by obtaining QR codes
- Monitor and check instance connection status
FAQ from MCP Evolution API
What are the requirements to run MCP Evolution API?
Node.js 18 or higher and NPM or Yarn are required. You also need access to an Evolution API installation (URL and API key).
How do I authenticate requests to MCP Evolution API?
Add an X-API-Key header with the key defined in the API_KEY environment variable. All routes except /initialize require this authentication.
What tools are available in MCP Evolution API?
The server exposes four tools: createEvolutionInstance, listEvolutionInstances, getWhatsAppQrCode, and sendWhatsAppMessage.
How can I deploy MCP Evolution API with Docker?
Run docker run -d -p 3000:3000 -e EVOLUTION_API_URL=... -e EVOLUTION_API_KEY=... -e API_KEY=... --name mcp-evolution-api generaai/mcp-evolution-api:latest. You can also use an .env.docker file with --env-file or Docker Compose.
Where does my WhatsApp data live when using MCP Evolution API?
The README does not specify data storage details. The server interfaces with the Evolution API, so data likely resides on the Evolution API server you connect to.
