MCP Evolution API

An MCP server for Claude that integrates with the Evolution API for WhatsApp automation.

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

EnvironmentStepsCommand
Local Development1. Clone and install2. Run in dev modegit clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun installbun run dev
Local Production1. Clone and install2. Build and rungit clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun installbun run build && bun run dist/main.js
Docker ComposeRun with Docker Composegit clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-apidocker-compose up -d
DockerBuild and run containerdocker 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

CategoryImplementedPending 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.

Related Servers