Skip to main content

MCP Server for WATI WhatsApp Business API integration

Project description

WATI MCP Server

A Model Context Protocol (MCP) server that provides seamless integration with the WATI WhatsApp Business API. This server enables AI assistants to send messages, manage contacts, retrieve conversation data, and handle media files through WhatsApp Business accounts.

Features

  • Message Management: Send and receive WhatsApp messages
  • Contact Management: Add, update, and search contacts with custom attributes
  • Template Messages: Send pre-approved template messages and broadcasts
  • Media Handling: Send and receive media files (images, documents, etc.)
  • Conversation History: Retrieve message history with pagination and filtering
  • Bulk Operations: Send messages to multiple recipients via CSV upload
  • Real-time Integration: Works with any MCP-compatible AI assistant

Installation

Step 1: Install the Package

Recommended: Using pipx (best for CLI tools)

pipx install wati-mcp-server

Alternative: Using pip with virtual environment

python3 -m venv mcp-env
source mcp-env/bin/activate
pip install wati-mcp-server

Step 2: Find Installation Path

Find where the command was installed:

which wati-mcp-server

This will show a path like /Users/username/.local/bin/wati-mcp-server (pipx) or /path/to/mcp-env/bin/wati-mcp-server (venv).

Step 3: Configure Your MCP Client

For Claude Desktop: Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows)

For Cursor: Edit your Cursor MCP configuration file

Add this configuration:

{
  "mcpServers": {
    "wati": {
      "command": "/full/path/from/which/command",
      "env": {
        "API_ENDPOINT": "https://live-mt-server.wati.io/YOUR_TENANT_ID",
        "ACCESS_TOKEN": "Bearer YOUR_WATI_ACCESS_TOKEN"
      }
    }
  }
}

Or if pipx added it to your PATH, you can use:

{
  "mcpServers": {
    "wati": {
      "command": "wati-mcp-server",
      "env": {
        "API_ENDPOINT": "https://live-mt-server.wati.io/YOUR_TENANT_ID",
        "ACCESS_TOKEN": "Bearer YOUR_WATI_ACCESS_TOKEN"
      }
    }
  }
}

Step 4: Get Your WATI Credentials

  1. Sign up for a WATI account
  2. Get your WhatsApp Business API approved
  3. Find your API endpoint and access token in the WATI dashboard
  4. Replace YOUR_TENANT_ID and YOUR_WATI_ACCESS_TOKEN in the config above

Step 5: Restart Your MCP Client

After updating the configuration, completely restart Claude Desktop or Cursor.

Available Tools

The server provides the following MCP tools:

Message Operations

  • get_messages - Retrieve WhatsApp messages for a specific number
  • send_message_to_opened_session - Send a message to an open WhatsApp session
  • send_template_message - Send a pre-approved template message
  • send_template_messages - Send template messages to multiple recipients
  • send_template_messages_from_csv - Bulk send template messages from CSV file

Contact Management

  • get_contacts_list - Retrieve contacts with filtering options
  • add_contact - Add a new WhatsApp contact
  • update_contact_attributes - Update custom attributes for a contact

Templates and Media

  • get_message_templates - Retrieve available message templates
  • get_media_by_filename - Get media file details
  • send_file_to_opened_session - Send files to WhatsApp sessions

Utility

  • get_weather - Demo weather function (for testing)

Usage Examples

Send a Template Message

# The AI assistant can use this tool:
send_template_message(
    whatsapp_number=919909000282,
    template_name="welcome_message",
    broadcast_name="new_user_welcome",
    parameters=[
        {"name": "customer_name", "value": "John Doe"},
        {"name": "company_name", "value": "ACME Corp"}
    ]
)

Search Contacts

# Find contacts in a specific city
get_contacts_list(
    attribute='[{"name":"city","operator":"=","value":"Mumbai"}]',
    page_size=20
)

Send Bulk Messages

# Send to multiple recipients
send_template_messages(
    template_name="promotional_offer",
    broadcast_name="summer_sale_2024",
    receivers=[
        {
            "whatsappNumber": "919909000282",
            "customParams": [{"name": "offer_code", "value": "SUMMER25"}]
        },
        {
            "whatsappNumber": "919909000283", 
            "customParams": [{"name": "offer_code", "value": "SUMMER30"}]
        }
    ]
)

Configuration

Environment Variables

Variable Description Required
API_ENDPOINT Your WATI API endpoint URL Yes
ACCESS_TOKEN Your WATI API access token Yes

Development

Setting up for Development

# Clone the repository
git clone https://github.com/Jairajmehra/wati_whatsapp_mcp.git
cd wati_whatsapp_mcp

# Install in development mode
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

Running Tests

pytest

Code Formatting

black wati_mcp/
flake8 wati_mcp/
mypy wati_mcp/

Building for Distribution

python -m build

API Reference

WATIClient Class

The core client class that handles all API interactions:

from wati_mcp.server import WATIClient

client = WATIClient(api_endpoint="...", access_token="...")

Server Creation

from wati_mcp.server import create_server

# Create a configured MCP server
server = create_server()

Error Handling

The server includes comprehensive error handling:

  • API request failures are caught and returned as structured error responses
  • File operations include existence checks and proper error messages
  • Environment variable validation with helpful error messages
  • Structured logging for debugging and monitoring

Contributing

We welcome contributions! Please see our Contributing Guide for details.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Changelog

v0.1.0

  • Initial release
  • Core WhatsApp messaging functionality
  • Contact management features
  • Template message support
  • Media file handling
  • Bulk messaging capabilities

Built with ❤️ for the MCP ecosystem

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wati_mcp_server-0.1.1.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wati_mcp_server-0.1.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file wati_mcp_server-0.1.1.tar.gz.

File metadata

  • Download URL: wati_mcp_server-0.1.1.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for wati_mcp_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 adcc3dd0c5fef5ce86863be018c760d1181c1ae6c5a7a5e9a69ce17b6d69a5a1
MD5 47b23eaa8f011ca2686106ec162e68fb
BLAKE2b-256 2d2caa3b030d87c69a512378ca1ca239bdb584f0b962f45a46bdac34e612294e

See more details on using hashes here.

File details

Details for the file wati_mcp_server-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wati_mcp_server-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef4807a6af93113081a9209d99805e89b538311a28c25db0f5ba399a1693f076
MD5 8fbb2ac248ee52652c25bbb282340ec7
BLAKE2b-256 a8efe705e1dc9212f679606258b0b6ae7ed5b1575ced70c3b9db548a56329859

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page