mcpField
M
mcp-evolution-api

mcp-evolution-api

Local
github.com/codesparCommunication275Updated 4w ago

About mcp-evolution-api

mcp-evolution-api is an MCP server for Evolution API, a self-hosted WhatsApp messaging API. It covers message sending, instance management, and contact and group operations. It suits developers who want an AI assistant to manage WhatsApp accounts.

Key features

  1. 01Text, image and document message sending
  2. 02Instance creation, connection state and restart
  3. 03Contact and message history retrieval
  4. 04Group creation and participant management
  5. 05Chat archiving and message deletion

Use cases

  1. 01Sending WhatsApp messages or polls from an AI assistant
  2. 02Checking whether a phone number is registered on WhatsApp
  3. 03Managing group participants and invite links

MCP support

The server exposes 25 tools over MCP that call WhatsApp functions on a self-hosted Evolution API instance.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
"mcpServers": {
"codespar-mcp-evolution-api": {
"command": "npx",
"args": [
"-y",
"@codespar/mcp-evolution-api"
],
"env": {
"EVOLUTION_API_KEY": "<EVOLUTION_API_KEY>"
}
}
}
}
Run commandnpx -y @codespar/mcp-evolution-api
Environment variables to set
EVOLUTION_API_KEYSecretAPI key for evolution-api

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npm@codespar/mcp-evolution-api0.2.2

Tools

25

Saved tool list · updated 2w ago

ParameterTypeRequiredDescription
textstringYesMessage text
numberstringYesPhone number with country code (e.g. 5511999999999)
instancestringYesInstance name

Details

From the project README

@codespar/mcp-evolution-api

MCP server for Evolution API — self-hosted WhatsApp messaging API

npm License: MIT

Quick Start

Claude Desktop

Add to ~/.config/claude/claude_desktop_config.json:

{
  "mcpServers": {
    "evolution-api": {
      "command": "npx",
      "args": ["-y", "@codespar/mcp-evolution-api"],
      "env": {
        "EVOLUTION_API_URL": "https://your-instance.example.com",
        "EVOLUTION_API_KEY": "your-key"
      }
    }
  }
}
Claude Code
claude mcp add evolution-api -- npx @codespar/mcp-evolution-api
Cursor / VS Code

Add to .cursor/mcp.json or .vscode/mcp.json:

{
  "servers": {
    "evolution-api": {
      "command": "npx",
      "args": ["-y", "@codespar/mcp-evolution-api"],
      "env": {
        "EVOLUTION_API_URL": "https://your-instance.example.com",
        "EVOLUTION_API_KEY": "your-key"
      }
    }
  }
}

Tools (25)

ToolPurpose
send_textSend a text message via WhatsApp
send_imageSend an image message via WhatsApp
send_documentSend a document via WhatsApp
get_instancesList all WhatsApp instances
create_instanceCreate a new WhatsApp instance
get_qrcodeGet QR code for instance pairing
get_contactsGet contacts from an instance
send_pollSend a poll message via WhatsApp
get_messagesGet messages from a chat
check_numberCheck if a phone number is registered on WhatsApp
create_groupCreate a WhatsApp group
get_group_infoGet group metadata, participants, and settings
update_profileUpdate instance profile (name, status text, or picture)
set_presenceSet online/offline presence for an instance
get_chat_historyGet full chat history with pagination support
logout_instanceLogout an instance (disconnects the WhatsApp session without deleting the instance)
restart_instanceRestart an instance
delete_instanceDelete an instance permanently
connection_stateGet the connection state of an instance (open, connecting, close)
leave_groupLeave a WhatsApp group
update_group_participantsAdd, remove, promote, or demote participants in a WhatsApp group
fetch_group_invite_codeFetch the invite code/link for a WhatsApp group
mark_message_as_readMark one or more messages in a chat as read
archive_chatArchive or unarchive a chat
delete_messageDelete a message for me or for everyone in a chat

Authentication

Evolution API uses an API key passed via the apikey header.

Sandbox / Testing

Evolution API is self-hosted. Deploy your own instance using Docker for testing.

Get your credentials
  1. Go to Evolution API Documentation
  2. Deploy your own instance (Docker recommended)
  3. Get the API key from your instance configuration
  4. Set the environment variables

Environment Variables

VariableRequiredDescription
EVOLUTION_API_URLYesBase URL of your Evolution API instance
EVOLUTION_API_KEYYesAPI key for authentication

Roadmap

v0.2 (planned)
  • create_group — Create a WhatsApp group
  • get_group_info — Get group details and participants
  • update_profile — Update instance profile (name, photo, status)
  • set_presence — Set online/offline presence status
  • get_chat_history — Get full chat history with a contact
v0.3 (planned)
  • bulk_send — Send messages to multiple contacts
  • template_messages — Send WhatsApp Business template messages
  • label_management — Create, update, and assign labels to chats

Want to contribute? Open a PR or request a tool.

Links

Enterprise

Need governance, budget limits, and audit trails for agent payments? CodeSpar Enterprise adds policy engine, payment routing, and compliance templates on top of these MCP servers.

License

MIT

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.