Evolution API

@codespar/mcp-evolution-api · v0.2.2

🇧🇷 BrazilMessagingAuth · API Keylive25 tools2 env vars

WhatsApp multi-device with QR code pairing. Messaging, groups, status updates, and contacts -- self-hosted friendly.

Get started · free View docs

MIT · runs locally with your own credentials

Limitations

The package manifest does not declare 1 of the 2 variables the code reads.

DetailsSource on GitHub

Package: @codespar/mcp-evolution-api
Version: 0.2.2
npm dist-tag: latest
Category: Messaging
Auth: API Key
Country: 🇧🇷 Brazil
License: MIT
Transport: stdio · streamable-http

npm GitHub Server catalog docs

Quickstart

Install, set the credentials, make the first call.

Pick your client. The server runs locally over stdio, with your own credentials.

Add the server to your clientOne config entry. No build step, no SDK required.

Set the environment variables2 variables read by this server's code, listed below.

Restart and make the first callThe agent can call any of the 25 tools. Try send_text first.

Hosted MCP Build your own server

terminal

# Claude Code
claude mcp add evolution-api -e EVOLUTION_API_KEY=… -e EVOLUTION_API_URL=… -- npx -y @codespar/mcp-evolution-api@0.2.2
# then: /mcp to confirm the server is connected

Environment variables2 variables

EVOLUTION_API_KEYAPI key for evolution-apirequiredsecret

EVOLUTION_API_URLRead by the code; the package manifest does not declare it.

Names read from the package code (@codespar/mcp-evolution-api@0.2.2). Descriptions and flags come from its manifest. Self-hosted, you hold the credentials.

First call demosend_text

"Send a text message via WhatsApp"

tools/callsend_textresult returned

Tools

What your agent can call.

25 tools, as the package's tools/list returns them.

send_text

Send a text message via WhatsApp

send_image

Send an image message via WhatsApp

send_document

Send a document via WhatsApp

get_instances

List all WhatsApp instances

create_instance

Create a new WhatsApp instance

get_qrcode

Get QR code for instance pairing

get_contacts

Get contacts from an instance

send_poll

Send a poll message via WhatsApp

get_messages

Get messages from a chat

check_number

Check if a phone number is registered on WhatsApp

create_group

Create a WhatsApp group

get_group_info

Get group metadata, participants, and settings

Names and descriptions come from the package's tools/list (@codespar/mcp-evolution-api@0.2.2). A kind (read, write, delete) is shown only when the package annotates its tools or each tool was verified one by one; neither exists for this server yet.

Compatibility

MCP is a protocol. Any client that speaks it can mount this server.

The CodeSpar runtime does not route this server. Mount it in your client over stdio · streamable-http.

Protocol

Any MCP client

stdio · streamable-http

Questions

Before you install.

How do I install the Evolution API MCP server?

Run npx -y @codespar/mcp-evolution-api@0.2.2 and add the config block above to your MCP client: Claude Code, Cursor, Claude Desktop, VS Code, or any MCP-compatible client. No build step, no SDK required.

What can my agent do with Evolution API?

Evolution API exposes 25 tools for messaging. Your agent calls them directly; the full list is above.

How does Evolution API authenticate, and how are credentials stored?

Evolution API uses API Key. Self-hosted, you hold the credentials: the server reads them from its environment variables.

How does Evolution API handle upstream API changes?

Every server is versioned independently on npm. The command on this page pins 0.2.2, the version whose tools are listed here; your agent keeps running it until you change the version.

Is Evolution API open source? How do I report a bug?

Yes. Evolution API is MIT-licensed and published on npm as @codespar/mcp-evolution-api, source on GitHub (link in the Details panel). Report issues on the package repository; security issues go to security@codespar.dev, and we respond within 24 hours.

Pairs well with