Mcp Z Api

io.github.codesparPublished by GitHub account codesparv0.2.2Updated Oct 25, 2026

MCP server for Z-API — WhatsApp messaging, contacts, media

VerifiedSTDIODesktop onlyProductivity & Workflow Communication & Collaboration

Server details

Identifier: io.github.codespar/mcp-z-api
Transport: STDIO
Runtime: Desktop only
Trust: Verified
Published: Sep 16, 2026

Security note

MCP servers receive tool arguments from a conversation and may perform external actions. Review what a server can do before you enable it, and give it only the access it needs.

The registry verified the GitHub account codespar for this listing. That does not show the account is the product's maker.

SourceWeft's checks cover whether the listing is complete and the endpoint answered; they do not review the server's code or what its tools do.

Add a badge to your README

Show readers this MCP server is listed on SourceWeft. The badge links to this page.

[![Listed on SourceWeft](https://sourceweft.com/badge/mcp/io.github.codespar%2Fmcp-z-api.svg)](https://sourceweft.com/mcp/io.github.codespar%2Fmcp-z-api?utm_source=readme&utm_medium=badge)

Overview

AI-generated overview

Local MCP server for Z-API that lets an assistant send WhatsApp messages and media, manage contacts, chats and groups through a Z-API instance.

What you can do: Send text, image, document, audio, location and contact-card messages, plus interactive button and option lists, over WhatsApp through Z-API. Read chats and messages, mark messages or whole chats as read or unread, and delete messages. List and inspect contacts, check whether a number has WhatsApp, fetch profile pictures and contact metadata, and add contacts. Create groups, list groups, read group metadata and participants, and add or remove participants. Assign and list labels and tags, and check the WhatsApp instance connection status.
When to use it: Useful when an assistant should operate a WhatsApp account through Z-API: sending notifications or media, answering or triaging chats, managing contacts and groups, or checking instance status. Only worth adding if you already have or plan to create a Z-API instance.
Requirements: Runs locally as an npm package started with npx, so Node.js is needed. Requires a Z-API account with a free trial or paid plan, and the instance ID and token supplied through the ZAPI_INSTANCE_ID and ZAPI_TOKEN environment variables. Network access to the Z-API service is required.

Before you install

The ZAPI_TOKEN and instance ID are credentials for a live WhatsApp account; keep them out of shared configs. Many tools write or change data: sending messages, creating groups, adding or removing participants, adding contacts, marking read and deleting messages. Messages and media go to third parties through Z-API. The README also mentions a separate enterprise offering with payment routing, which is not part of this server.

Installation

In SourceWeft

Open Mcp Z Api in the dashboard and add it to a workspace.
Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

@codespar/mcp-z-api

MCP server for Z-API — WhatsApp messaging platform

[npm] [License: MIT]

Quick Start

Claude Desktop

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

json

{  "mcpServers": {    "z-api": {      "command": "npx",      "args": ["-y", "@codespar/mcp-z-api"],      "env": {        "ZAPI_INSTANCE_ID": "your-instance-id",        "ZAPI_TOKEN": "your-token"      }    }  }}

{  "mcpServers": {    "z-api": {      "command": "npx",      "args": ["-y", "@codespar/mcp-z-api"],      "env": {        "ZAPI_INSTANCE_ID": "your-instance-id",        "ZAPI_TOKEN": "your-token"      }    }  }}

Claude Code

Cursor / VS Code

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

json

{  "servers": {    "z-api": {      "command": "npx",      "args": ["-y", "@codespar/mcp-z-api"],      "env": {        "ZAPI_INSTANCE_ID": "your-instance-id",        "ZAPI_TOKEN": "your-token"      }    }  }}

{  "servers": {    "z-api": {      "command": "npx",      "args": ["-y", "@codespar/mcp-z-api"],      "env": {        "ZAPI_INSTANCE_ID": "your-instance-id",        "ZAPI_TOKEN": "your-token"      }    }  }}

Tools (27)

Tool	Purpose
`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
`add_group_participant`	Add a participant to a WhatsApp group
`remove_group_participant`	Remove a participant from a WhatsApp group
`send_location`	Send a location message via WhatsApp
`send_contact`	Send a contact card via WhatsApp
`add_label`	Assign a label/tag to a chat
`get_labels`	List all available labels/tags
`read_message`	Mark messages as read
`delete_message`	Delete a message
`get_contact_metadata`	Get metadata (name, WhatsApp display name, profile picture, status) for a single contact
`add_contacts`	Add one or more contacts to the WhatsApp address book.
`list_chats`	List all WhatsApp chats with pagination
`mark_chat_as_read`	Mark an entire chat as read or unread
`list_groups`	List all WhatsApp groups with pagination
`send_option_list`	Send an interactive option list (WhatsApp native list).
`send_button_actions`	Send interactive action buttons (CALL, URL, REPLY).

Authentication

Z-API uses instance ID and token embedded in the request URL.

Sandbox / Testing

Z-API offers a free trial for testing. Create an account to get started.

Get your credentials

Go to Z-API Developer Portal
Create an account and start a free trial
Get your instance ID and token
Set the environment variables

Environment Variables

Roadmap

v0.2 (planned)

send_sticker — Send a sticker message via WhatsApp
send_reaction — Send a reaction to a message
get_chat_history — Get full chat history with a contact
update_group_settings — Update group name, description, settings
leave_group — Leave a WhatsApp group

v0.3 (planned)

bulk_messaging — Send messages to multiple contacts
template_management — Create and manage message templates
catalog_products — Manage WhatsApp Business catalog products

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

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

Source: packages/communication/z-api/README.md at commit d0a519a

Tools

SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

v0.2.2LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

Reached in the last 30 days25 pts
Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.
Auth declared10 pts
Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.
Tools listed15 pts
Answer tools/list without a credential, or ship a package that starts in a sandbox without one.
DescriptionRequired15 pts
Logo10 pts
Documentation15 pts
License10 pts

Variable	Required	Description
`ZAPI_INSTANCE_ID`	Yes	Z-API instance ID
`ZAPI_TOKEN`	Yes	Z-API instance token