Evolution WhatsApp API MCP server

The MCP Evolution API server creates a bridge between Claude and WhatsApp through Evolution API, enabling Claude to send messages, manage WhatsApp instances, work with contacts and groups, and configure settings directly through WhatsApp.

Installation

Prerequisites

• An Evolution API server instance
• Your Evolution API credentials (URL and API key)

Setting Up Environment

Create a .env file in your project root with your Evolution API credentials:

EVOLUTION_API_URL=https://your-evolution-api-server.com
EVOLUTION_API_KEY=your-api-key-here

Installation Options

Using Docker (Recommended)

Run the pre-built Docker image:

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

Using Docker Compose

1. Clone the repository:

git clone https://github.com/aiteks-ltda/mcp-evo-api.git
cd mcp-evo-api

2. Start with Docker Compose:

docker-compose up -d

Local Installation

1. Clone the repository and install dependencies:

git clone https://github.com/aiteks-ltda/mcp-evo-api.git
cd mcp-evo-api
bun install

2. For development mode:

bun run dev

3. For production mode:

bun run build
bun run dist/main.js

Configuration with Claude Desktop

After installing the MCP server, you need to configure Claude Desktop to use it.

Edit your Claude Desktop config file (typically at ~/Library/Application Support/Claude/claude_desktop_config.json):

For Local Installation

{
  "mcpServers": {
    "evo-api": {
      "command": "node",
      "args": [
        "/path/to/your/mcp-evo-api/dist/main.js"
      ]
    }
  }
}

For Docker Installation

{
  "mcpServers": {
    "evo-api": {
      "url": "http://localhost:3000"
    }
  }
}

Using the MCP Server

Once configured, Claude can use various WhatsApp functionalities through the Evolution API. The MCP server supports:

Core WhatsApp Instance Management

• Creating new WhatsApp instances
• Connecting to WhatsApp
• Monitoring connection state
• Restarting, logging out, and deleting instances

Messaging Capabilities

• Sending text messages
• Sending media (images, videos, documents)
• Sending audio messages
• Sending stickers
• Sharing locations
• Sending contacts
• Creating message reactions
• Creating polls
• Sending interactive lists and buttons

Contacts and Chats

• Finding and retrieving contacts
• Listing and accessing chats

Group Management

• Finding groups by JID
• Fetching all available groups
• Retrieving group member information

Webhooks and Settings

• Setting up and configuring webhooks
• Managing WhatsApp settings

Feature Implementation Status

The MCP server currently implements most core functionality including instance management, messaging, and basic group management. Some advanced features like group creation, profile management, and third-party bot integrations are pending implementation.

For a complete list of available Evolution API endpoints, refer to the official documentation.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.