Documentation Index Fetch the complete documentation index at: https://docs.zavu.dev/llms.txt
Use this file to discover all available pages before exploring further.
The Zavu MCP Server enables AI assistants like Claude, Cursor, and others to interact directly with the Zavu API. Send messages, manage templates, create broadcasts, and more through natural language.
Quick Start Run the MCP Server directly via npx:
export ZAVUDEV_API_KEY = "Your API Key" npx -y @zavudev/sdk-mcp@latest
Installation by Client Claude Desktop Add to your Claude Desktop configuration file:
// ~/Library/Application Support/Claude/claude_desktop_config.json { "mcpServers" : { "zavudev_sdk_api" : { "command" : "npx" , "args" : [ "-y" , "@zavudev/sdk-mcp" , "--client=claude" , "--tools=dynamic" ], "env" : { "ZAVUDEV_API_KEY" : "Your API Key" } } } }
Cursor Click the button below to install the MCP server in Cursor. You’ll need to set your API key in Cursor’s mcp.json (Settings > Tools & MCP > New MCP Server).
Or add manually:
{ "mcpServers" : { "zavudev_sdk_api" : { "command" : "npx" , "args" : [ "-y" , "@zavudev/sdk-mcp" , "--client=cursor" , "--tools=dynamic" ], "env" : { "ZAVUDEV_API_KEY" : "Your API Key" } } } }
VS Code Click the link below to install. Set your API key via Command Palette > MCP: Open User Configuration.
Install in VS Code Claude Code Run in your terminal:
claude mcp add --transport stdio zavudev_sdk_api --env ZAVUDEV_API_KEY="Your API Key" -- npx -y @zavudev/sdk-mcp
There are three ways to expose API endpoints as tools:
Exposes one tool per API endpoint. Best for focused use cases where you know which endpoints you need.
Use --tools=dynamic to expose tools that discover and invoke endpoints on-demand:
Tool Description list_api_endpointsDiscovers available endpoints with optional filtering get_api_endpoint_schemaGets detailed schema for a specific endpoint invoke_api_endpointExecutes any endpoint with parameters
This keeps context lightweight while providing full API access.
Code Execution Use --tools=code to expose:
Tool Description search_docsSearches API documentation executeRuns code against the TypeScript client
This allows the AI to implement complex logic by chaining API calls.
Filtering Endpoints Filter which tools are exposed:
# Filter by resource --resource = messages --resource = templates # Filter by operation type --operation = read # Only get/list operations --operation = write # Only create/update/delete operations # Include specific tools --tool = send_messages --tool = list_templates # Exclude specific tools --no-tool = delete_senders # Combine filters --resource = messages --operation = read --no-tool = list_messages
Use --list to see all available tools.
Client Configuration Specify your MCP client for optimized compatibility:
--client = claude --client = claude-code --client = cursor --client = openai-agents
For advanced configuration, use capabilities:
--capability = top-level-unions --capability = tool-name-length = 40 --capability = refs --capability = unions
Running Remotely Launch as a remote HTTP server:
npx -y @zavudev/sdk-mcp --transport=http --port=3000
Configure clients to connect:
{ "mcpServers" : { "zavudev_sdk_api" : { "url" : "http://localhost:3000" , "headers" : { "Authorization" : "Bearer <your-api-key>" } } } }
Query parameters work for filtering: http://localhost:3000?resource=messages&operation=read
Messages Tool Type Description send_messageswrite Send SMS, WhatsApp, or email messages retrieve_messagesread Get message by ID list_messagesread List sent messages react_messageswrite Send emoji reaction to WhatsApp message
Templates Tool Type Description create_templateswrite Create WhatsApp message template retrieve_templatesread Get template details list_templatesread List all templates delete_templateswrite Delete a template submit_templateswrite Submit template for Meta approval
Senders Tool Type Description create_senderswrite Create sender profile retrieve_sendersread Get sender details update_senderswrite Update sender list_sendersread List all senders delete_senderswrite Delete sender get_profile_sendersread Get WhatsApp Business profile update_profile_senderswrite Update WhatsApp Business profile upload_profile_picture_senderswrite Upload profile picture regenerate_webhook_secret_senderswrite Regenerate webhook secret
Tool Type Description retrieve_contactsread Get contact by ID update_contactswrite Update contact list_contactsread List all contacts retrieve_by_phone_contactsread Get contact by phone number
Broadcasts Tool Type Description create_broadcastswrite Create broadcast campaign retrieve_broadcastsread Get broadcast details update_broadcastswrite Update draft broadcast list_broadcastsread List all broadcasts delete_broadcastswrite Delete draft broadcast send_broadcastswrite Start sending broadcast cancel_broadcastswrite Cancel active broadcast progress_broadcastsread Get real-time progress add_broadcasts_contactswrite Add contacts to broadcast list_broadcasts_contactsread List broadcast contacts remove_broadcasts_contactswrite Remove contact from broadcast
Phone Numbers Tool Type Description search_available_phone_numbersread Search numbers to purchase purchase_phone_numberswrite Purchase a phone number retrieve_phone_numbersread Get phone number details update_phone_numberswrite Update phone number list_phone_numbersread List owned numbers release_phone_numberswrite Release a phone number
Introspect Tool Type Description validate_phone_introspectwrite Validate phone and check WhatsApp window
Usage Examples Once configured, ask your AI assistant:
“Send an SMS to +1234567890 saying ‘Hello from Zavu’”
“List my WhatsApp templates”
“Create a broadcast campaign for Black Friday”
“Check the progress of my current broadcast”
“Search for available US phone numbers”
Learn More
Coding Agent Skills Add intelligent API context to your coding agent with pre-built skills
Model Context Protocol Learn about the MCP standard
API Reference Explore the full Zavu API
Or add manually: