Z-API

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

🇧🇷 BrazilMessagingAuth · API Keylive27 tools2 env vars

WhatsApp Business API: messages, media, templates, and delivery webhooks. Your agent sends receipts, confirmations, and support responses.

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.
Hosted calls with a test key are not available: the provider has no test environment.

DetailsSource on GitHub

Package: @codespar/mcp-z-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 27 tools. Try send_text first.

Hosted MCP Build your own server

terminal

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

Environment variables2 variables

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

ZAPI_TOKENAPI key for z-apirequiredsecret

Names read from the package code (@codespar/mcp-z-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.

27 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

send_audio

Send an audio message via WhatsApp

get_contacts

Get all WhatsApp contacts

check_number

Check if a phone number has WhatsApp

get_profile_picture

Get profile picture URL for a phone number

get_messages

Get messages for a phone number

send_button_list

Send a button list message via WhatsApp

get_status

Get WhatsApp instance connection status

create_group

Create a WhatsApp group

get_group_metadata

Get group metadata and participants

Names and descriptions come from the package's tools/list (@codespar/mcp-z-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.

codespar_discover lists this server's tools, but a project with a test key cannot call them: the provider has no test environment, so the runtime refuses test-mode calls.

Protocol

Any MCP client

stdio · streamable-http

Questions

Before you install.

How do I install the Z-API MCP server?

Run npx -y @codespar/mcp-z-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 Z-API?

Z-API exposes 27 tools for messaging. Your agent calls them directly; the full list is above.

How does Z-API authenticate, and how are credentials stored?

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

How does Z-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 Z-API open source? How do I report a bug?

Yes. Z-API is MIT-licensed and published on npm as @codespar/mcp-z-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