{"_id":"@codespar/mcp-z-api","_rev":"6-9b63573ee825a2fc67f91a7e18a529de","name":"@codespar/mcp-z-api","dist-tags":{"latest":"0.2.2"},"versions":{"0.1.0":{"name":"@codespar/mcp-z-api","version":"0.1.0","keywords":["mcp","z-api","whatsapp","messaging","brazil"],"license":"MIT","_id":"@codespar/mcp-z-api@0.1.0","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-z-api":"dist/index.js"},"dist":{"shasum":"5b3c7d656ff5a5c3963b49861f67e1335c43b6c2","tarball":"https://registry.npmjs.org/@codespar/mcp-z-api/-/mcp-z-api-0.1.0.tgz","fileCount":4,"integrity":"sha512-rxuddJ6gz65jBrWoyMXG3UCDTLk+3MNdtp90lW9IpYfN+tXYKKMLB4grhXnNecPqpJil9lWd91bZQUyPGCOZIA==","signatures":[{"sig":"MEUCIHvgp2wMW49uTjtbsf7AZeo0MogV+g/7rAKhOjXzO+NFAiEAwpCJ0pT+r+GHlCwWQ9/PPSpquiawi+QfP5ibqhnchjw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":16442},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"ac49d04d5aa50ad5dc16233f0bba88213f917641","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Z-API — WhatsApp messaging, contacts, media","directories":{},"_nodeVersion":"25.5.0","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-z-api_0.1.0_1774923332253_0.7276858895410581","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@codespar/mcp-z-api","version":"0.1.2","keywords":["mcp","z-api","whatsapp","messaging","brazil"],"license":"MIT","_id":"@codespar/mcp-z-api@0.1.2","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-z-api":"dist/index.js"},"dist":{"shasum":"5a173edb8b82dd571210b941e509a13b580152a2","tarball":"https://registry.npmjs.org/@codespar/mcp-z-api/-/mcp-z-api-0.1.2.tgz","fileCount":7,"integrity":"sha512-dhxkWEDZ07Zue+6byykqb4bk+G6CsYQ+W6jYKw8KF44B1EIxH5Y0nrXyM9iS97u5QbQK+plVlJ5FuWDZPYUZxA==","signatures":[{"sig":"MEUCID1W8aKwjeAAVTelz5Rjlh/qE9W7u5KmdcTx78e6BELTAiEA3N2ONIDsB/8iCdBrj1zVZRmxk6Hv3VWQHjKSJzcNOuo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":48629},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"8fd47fad095cdf96618460a39345eddfe2a4af21","mcpName":"io.github.codespar/mcp-z-api","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Z-API — WhatsApp messaging, contacts, media","directories":{},"_nodeVersion":"25.5.0","dependencies":{"zod":"^3.23.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-z-api_0.1.2_1775953667230_0.49792807797757166","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@codespar/mcp-z-api","version":"0.2.0","keywords":["mcp","z-api","whatsapp","messaging","brazil"],"license":"MIT","_id":"@codespar/mcp-z-api@0.2.0","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-z-api":"dist/index.js"},"dist":{"shasum":"6361c968c1da9c1f30680483f77f413bdeeacc0f","tarball":"https://registry.npmjs.org/@codespar/mcp-z-api/-/mcp-z-api-0.2.0.tgz","fileCount":7,"integrity":"sha512-d8zVlciZMC12cY6Xn8yMI10cxID1jJUvZtHWdcvQ7iX9NWuvqQb2TGg//O5bSKby9rXU/44nYp0ln+bMSWfvlA==","signatures":[{"sig":"MEUCIGPxs4ZXkDtxwo7NNiqUAnE9qclKNdLfB7fffBfvvZyRAiEA4x2+Ysr8ZOISyH681ALWo83u98+hp2ktwLtC69dzvM4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":65677},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"b999d2a16b58ff41c781890e346d04a59801d6cb","mcpName":"io.github.codespar/mcp-z-api","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Z-API — WhatsApp messaging, contacts, media","directories":{},"_nodeVersion":"25.5.0","dependencies":{"zod":"^3.23.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-z-api_0.2.0_1777039140904_0.6396461109346236","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@codespar/mcp-z-api","version":"0.2.1","keywords":["mcp","z-api","whatsapp","messaging","brazil"],"license":"MIT","_id":"@codespar/mcp-z-api@0.2.1","maintainers":[{"name":"codespar-npm","email":"contact@codespar.dev"}],"bin":{"mcp-z-api":"dist/index.js"},"dist":{"shasum":"8b3f8a87b54e0037cc46af875022a13b55c18e0a","tarball":"https://registry.npmjs.org/@codespar/mcp-z-api/-/mcp-z-api-0.2.1.tgz","fileCount":7,"integrity":"sha512-NfUEx6HG2qH9wKerWfY5e5NZMumd+xT6KghQ1BMQjNgzndFiP9fxQVkqOXl0EWN6Hs0dUWkAkopeXwmNtgIoew==","signatures":[{"sig":"MEUCIQCUWEUd7z7oWnjxSEpNcNQBz+hD4jIXrYJZitQHNxlJFwIgPTLvJfDAeS6OvD7xLWk2eJd79NzQb/xVMFdOILM3E1I=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":66752},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"0ab801a863239f0cb986bbda65abbaee3c621b44","mcpName":"io.github.codespar/mcp-z-api","scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"codespar-npm","email":"contact@codespar.dev"},"_npmVersion":"11.8.0","description":"MCP server for Z-API — WhatsApp messaging, contacts, media","directories":{},"_nodeVersion":"25.5.0","dependencies":{"zod":"^3.23.0","@modelcontextprotocol/sdk":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.0","@types/node":"^25.5.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp-z-api_0.2.1_1777122996258_0.47977115136480886","host":"s3://npm-registry-packages-npm-production"}},"0.2.2":{"name":"@codespar/mcp-z-api","version":"0.2.2","description":"MCP server for Z-API — WhatsApp messaging, contacts, media","type":"module","main":"./dist/index.js","bin":{"mcp-z-api":"dist/index.js"},"scripts":{"build":"tsc","start":"node dist/index.js"},"dependencies":{"@modelcontextprotocol/sdk":"^1.0.0","zod":"^3.23.0"},"devDependencies":{"@types/node":"^25.5.0","typescript":"^5.8.0"},"license":"MIT","keywords":["mcp","z-api","whatsapp","messaging","brazil"],"mcpName":"io.github.codespar/mcp-z-api","_id":"@codespar/mcp-z-api@0.2.2","gitHead":"776ee260ec81f40a78c5f23f4ae78d64b475c0fa","types":"./dist/index.d.ts","_nodeVersion":"22.22.3","_npmVersion":"10.9.8","dist":{"integrity":"sha512-uTFTS6cjGcntBjvGA+/1IUowR71wjKEXCx8hsTS6MNeqpUkucpuCYb4gqhvRbZ8tUa9QiVuTACYYPfj2DBIUzA==","shasum":"271b2827046d1f631c3332bc7d811d0f894d73bb","tarball":"https://registry.npmjs.org/@codespar/mcp-z-api/-/mcp-z-api-0.2.2.tgz","fileCount":7,"unpackedSize":68007,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIB5Phs1tDGCbN/WNjf+MqGRgoI/LEEXlomVxw30/af4hAiBY7lt0D3MBaghJ+VW32LPySkcCKKbqbjtBevdQ51Bnsw=="}]},"_npmUser":{"name":"codespar-npm","email":"fabiano@codespar.dev"},"directories":{},"maintainers":[{"name":"codespar-npm","email":"fabiano@codespar.dev"},{"name":"dangazineu","email":"daniel.gazineu@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-z-api_0.2.2_1782149633748_0.21860435002624046"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-31T02:15:32.113Z","modified":"2026-06-22T17:33:54.065Z","0.1.0":"2026-03-31T02:15:32.455Z","0.1.2":"2026-04-12T00:27:47.378Z","0.2.0":"2026-04-24T13:59:01.033Z","0.2.1":"2026-04-25T13:16:36.391Z","0.2.2":"2026-06-22T17:33:53.889Z"},"license":"MIT","keywords":["mcp","z-api","whatsapp","messaging","brazil"],"description":"MCP server for Z-API — WhatsApp messaging, contacts, media","maintainers":[{"name":"codespar-npm","email":"fabiano@codespar.dev"},{"name":"dangazineu","email":"daniel.gazineu@gmail.com"}],"readme":"# @codespar/mcp-z-api\n\n> MCP server for **Z-API** — WhatsApp messaging platform\n\n[![npm](https://img.shields.io/npm/v/@codespar/mcp-z-api)](https://www.npmjs.com/package/@codespar/mcp-z-api)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n## Quick Start\n\n### Claude Desktop\n\nAdd to `~/.config/claude/claude_desktop_config.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"z-api\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@codespar/mcp-z-api\"],\n      \"env\": {\n        \"ZAPI_INSTANCE_ID\": \"your-instance-id\",\n        \"ZAPI_TOKEN\": \"your-token\"\n      }\n    }\n  }\n}\n```\n\n### Claude Code\n\n```bash\nclaude mcp add z-api -- npx @codespar/mcp-z-api\n```\n\n### Cursor / VS Code\n\nAdd to `.cursor/mcp.json` or `.vscode/mcp.json`:\n\n```json\n{\n  \"servers\": {\n    \"z-api\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@codespar/mcp-z-api\"],\n      \"env\": {\n        \"ZAPI_INSTANCE_ID\": \"your-instance-id\",\n        \"ZAPI_TOKEN\": \"your-token\"\n      }\n    }\n  }\n}\n```\n\n## Tools (27)\n\n| Tool | Purpose |\n|---|---|\n| `send_text` | Send a text message via WhatsApp |\n| `send_image` | Send an image message via WhatsApp |\n| `send_document` | Send a document via WhatsApp |\n| `send_audio` | Send an audio message via WhatsApp |\n| `get_contacts` | Get all WhatsApp contacts |\n| `check_number` | Check if a phone number has WhatsApp |\n| `get_profile_picture` | Get profile picture URL for a phone number |\n| `get_messages` | Get messages for a phone number |\n| `send_button_list` | Send a button list message via WhatsApp |\n| `get_status` | Get WhatsApp instance connection status |\n| `create_group` | Create a WhatsApp group |\n| `get_group_metadata` | Get group metadata and participants |\n| `add_group_participant` | Add a participant to a WhatsApp group |\n| `remove_group_participant` | Remove a participant from a WhatsApp group |\n| `send_location` | Send a location message via WhatsApp |\n| `send_contact` | Send a contact card via WhatsApp |\n| `add_label` | Assign a label/tag to a chat |\n| `get_labels` | List all available labels/tags |\n| `read_message` | Mark messages as read |\n| `delete_message` | Delete a message |\n| `get_contact_metadata` | Get metadata (name, WhatsApp display name, profile picture, status) for a single contact |\n| `add_contacts` | Add one or more contacts to the WhatsApp address book. |\n| `list_chats` | List all WhatsApp chats with pagination |\n| `mark_chat_as_read` | Mark an entire chat as read or unread |\n| `list_groups` | List all WhatsApp groups with pagination |\n| `send_option_list` | Send an interactive option list (WhatsApp native list). |\n| `send_button_actions` | Send interactive action buttons (CALL, URL, REPLY). |\n\n## Authentication\n\nZ-API uses instance ID and token embedded in the request URL.\n\n## Sandbox / Testing\n\nZ-API offers a free trial for testing. Create an account to get started.\n\n### Get your credentials\n\n1. Go to [Z-API Developer Portal](https://developer.z-api.io)\n2. Create an account and start a free trial\n3. Get your instance ID and token\n4. Set the environment variables\n\n## Environment Variables\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| `ZAPI_INSTANCE_ID` | Yes | Z-API instance ID |\n| `ZAPI_TOKEN` | Yes | Z-API instance token |\n\n## Roadmap\n\n### v0.2 (planned)\n- `send_sticker` — Send a sticker message via WhatsApp\n- `send_reaction` — Send a reaction to a message\n- `get_chat_history` — Get full chat history with a contact\n- `update_group_settings` — Update group name, description, settings\n- `leave_group` — Leave a WhatsApp group\n\n### v0.3 (planned)\n- `bulk_messaging` — Send messages to multiple contacts\n- `template_management` — Create and manage message templates\n- `catalog_products` — Manage WhatsApp Business catalog products\n\nWant to contribute? [Open a PR](https://github.com/codespar/mcp-dev-latam) or [request a tool](https://github.com/codespar/mcp-dev-latam/issues).\n\n## Links\n\n- [Z-API Website](https://z-api.io)\n- [Z-API Developer Documentation](https://developer.z-api.io)\n- [MCP Dev LATAM](https://github.com/codespar/mcp-dev-latam)\n- [Landing Page](https://codespar.dev/mcp)\n\n## Enterprise\n\nNeed governance, budget limits, and audit trails for agent payments? [CodeSpar Enterprise](https://codespar.dev/enterprise) adds policy engine, payment routing, and compliance templates on top of these MCP servers.\n\n## License\n\nMIT\n","readmeFilename":"README.md"}