Skip to main content

WhatsApp MCP Server — Manage Business templates & send messages via Meta Cloud API

Project description

WhatsApp MCP Server

Manage WhatsApp Business templates and send messages from Claude, ChatGPT, Cursor, VS Code Copilot, or any MCP-compatible client — powered by the Meta Cloud API.

MCP Compatible Meta API v24.0 MIT License Python 3.10+

What It Does

Tool Description
validate_template Validate a template payload before submitting to Meta
create_template Submit a template for Meta approval
list_templates List templates with optional filters (status, category, name)
get_template_detail Get full details of a template by ID
check_template_status Quick status check for a template
delete_template Delete a template by name
send_template_message Send an approved template to a phone number
send_bulk_template_messages Send an approved template to multiple phone numbers

8 tools covering the full template lifecycle: create → validate → approve → send.

Quick Start

1. Clone & Install

git clone https://github.com/nakulben/whatsapp-mcp.git
cd whatsapp-mcp
python -m venv venv
source venv/bin/activate   # Windows: venv\Scripts\activate
pip install -r requirements.txt

2. Configure Credentials

cp .env.example .env
META_ACCESS_TOKEN=your_access_token
META_WABA_ID=your_whatsapp_business_account_id
META_PHONE_NUMBER_ID=your_phone_number_id
META_APP_ID=your_app_id              # Optional, for media uploads
META_API_VERSION=v24.0               # Optional, defaults to v24.0

Environment variables are used by all modes — local stdio and hosted remote.

How to get these? Go to Meta for Developers, create or select your app, navigate to WhatsApp > API Setup.

3. Connect to Your MCP Client

The server supports 3 transport modes:

Transport Command Used By
stdio (default) python -m whatsapp_mcp Claude Desktop, Cursor, VS Code, Windsurf
sse python -m whatsapp_mcp --transport sse Legacy remote clients
streamable-http python -m whatsapp_mcp --transport streamable-http Claude.ai, ChatGPT, newer MCP clients

For HTTP transports, you can customize host/port:

python -m whatsapp_mcp --transport streamable-http --host 0.0.0.0 --port 8000

Claude Desktop (stdio — local)

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "whatsapp": {
      "command": "/path/to/whatsapp-mcp/venv/bin/python",
      "args": ["-m", "whatsapp_mcp"],
      "env": {
        "META_ACCESS_TOKEN": "your_access_token",
        "META_WABA_ID": "your_waba_id",
        "META_PHONE_NUMBER_ID": "your_phone_number_id",
        "META_APP_ID": "your_app_id"
      }
    }
  }
}

Claude.ai Web (remote — streamable-http)

Claude.ai connects to remote MCP servers as custom connectors. The connection originates from Anthropic's cloud servers, not from your machine.

  1. Host the server with env vars configured, behind HTTPS:
    python -m whatsapp_mcp --transport streamable-http --host 0.0.0.0 --port 8001
    
  2. Put it behind HTTPS using nginx, Caddy, or a tunnel (ngrok, Cloudflare Tunnel)
  3. In Claude.ai: go to Customize > Connectors → Add custom connector
  4. Enter your server URL (e.g. https://your-domain.com/mcp/)
  5. Claude supports authless or OAuth-based servers. For simplest setup, leave auth blank — the server will use the env vars you configured in step 1.

Note: Claude.ai does not support custom request headers. The server must be pre-configured with Meta credentials via environment variables. Each hosted server serves one WhatsApp Business Account.

Example nginx config
location /mcp/ {
    proxy_pass http://127.0.0.1:8001/;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_read_timeout 86400;
}

ChatGPT (remote — Responses API)

ChatGPT supports remote MCP servers via the Responses API. It supports both Streamable HTTP and SSE transports.

Option 1 — Server pre-configured with env vars (simplest):

from openai import OpenAI
client = OpenAI()
resp = client.responses.create(
    model="gpt-4.1",
    tools=[{
        "type": "mcp",
        "server_label": "whatsapp",
        "server_url": "https://your-domain.com/mcp/",
        "require_approval": "never",
    }],
    input="List all my approved templates",
)

Option 2 — Per-request credentials via Bearer token:

Encode your Meta credentials as base64 JSON and pass them in the authorization field. OpenAI forwards this value as the Authorization header to your MCP server:

# Create the token
echo -n '{"access_token":"EAA...","phone_number_id":"123","waba_id":"456"}' | base64
# Output: eyJhY2Nlc3NfdG9rZW4iOiJFQUEuLi4iLCJwaG9uZV9udW1iZXJfaWQiOiIxMjMiLCJ3YWJhX2lkIjoiNDU2In0=
resp = client.responses.create(
    model="gpt-4.1",
    tools=[{
        "type": "mcp",
        "server_label": "whatsapp",
        "server_url": "https://your-domain.com/mcp/",
        "authorization": "eyJhY2Nlc3NfdG9rZW4iOiJFQUEuLi4iLCJwaG9uZV9udW1iZXJfaWQiOiIxMjMiLCJ3YWJhX2lkIjoiNDU2In0=",
        "require_approval": "never",
    }],
    input="List all my approved templates",
)

Note: ChatGPT only supports remote MCP servers (no local stdio). Your server must be publicly accessible over HTTPS.

Cursor (stdio)

Add to .cursor/mcp.json in your project:

{
  "mcpServers": {
    "whatsapp": {
      "command": "/path/to/whatsapp-mcp/venv/bin/python",
      "args": ["-m", "whatsapp_mcp"]
    }
  }
}

VS Code Copilot (stdio)

Add to .vscode/mcp.json:

{
  "servers": {
    "whatsapp": {
      "type": "stdio",
      "command": "/path/to/whatsapp-mcp/venv/bin/python",
      "args": ["-m", "whatsapp_mcp"]
    }
  }
}

Per-Request Credentials (direct HTTP / curl / scripts)

For programmatic access or custom MCP clients, you can pass per-request credentials instead of relying on server env vars. Two methods are supported:

Method 1 — Bearer token (recommended):

Base64-encode a JSON object with your Meta credentials:

# Create the token
TOKEN=$(echo -n '{"access_token":"EAA...","phone_number_id":"123","waba_id":"456"}' | base64)

# Use it
curl -H "Authorization: Bearer $TOKEN" https://your-server.com/mcp/ ...

Required fields: access_token, phone_number_id, waba_id. Optional: app_id, api_version.

Method 2 — X-Meta- headers:*

Header Required Description
X-Meta-Access-Token Yes Your Meta access token
X-Meta-Phone-Number-Id Yes Your WhatsApp phone number ID
X-Meta-Business-Account-Id Yes Your WhatsApp Business Account ID
X-Meta-App-Id No Your Meta app ID (for media uploads)
X-Meta-Api-Version No API version (defaults to v24.0)

If neither Bearer token nor X-Meta-* headers are present, the server falls back to environment variables.

Usage Examples

Once connected, just talk to your AI assistant:

"Create a marketing template called summer_sale with a header image, body text about 50% off, and a Shop Now button"

"List all my approved templates"

"Send the order_confirmation template to +919876543210 with order number ORD-456"

"Validate this template before I submit it: ..."

"Check the status of template ID 123456789"

Supported Template Types

Meta's API has 2 template categories(excluding Authentication). Within each category, templates can have different structural variants — each with its own component layout and validation rules.

Marketing Templates

Structural Variant Create Send Key Components
Text / Image / Video / Document Header (optional) + Body + Footer + Buttons
Carousel Cards with per-card header, body, buttons
Catalog Body + CATALOG button
Limited-Time Offer (LTO) Body + limited_time_offer component + copy code button
Coupon Code Body + copy_code button
Multi-Product Message (MPM) Body + product_list action with sections
Single-Product Message (SPM) Body + product action
Product Card Carousel Body + product cards with buttons
Call Permission Body + call_permission button

Utility Templates

Structural Variant Create Send Key Components
Text / Image / Video / Document Header (optional) + Body + Footer + Buttons
Order Details Body + order_details button with payment payload
Order Status Body + order status parameters

How routing works: When you call create_template, the server inspects the components to auto-detect the structural variant (e.g., presence of cards[] → Carousel, CATALOG button → Catalog) and applies the correct validator. You just pass category: "MARKETING" or "UTILITY" — the variant is determined from the component structure.

Running Tests

pip install pytest pytest-asyncio
python -m pytest tests/ -v

Project Structure

whatsapp-mcp/
├── whatsapp_mcp/
│   ├── __init__.py          # Package version
│   ├── __main__.py          # Entry point (python -m whatsapp_mcp)
│   ├── config.py            # Environment config loader
│   ├── meta_api.py          # Async Meta Graph API client
│   ├── middleware.py         # ASGI middleware for per-request credentials
│   ├── server.py            # MCP server with 8 tools
│   ├── models/              # Pydantic data models
│   │   ├── body.py          # Body component
│   │   ├── header.py        # Header component (text/image/video/document)
│   │   ├── footer.py        # Footer component
│   │   ├── buttons.py       # Button types (URL, phone, quick reply, etc.)
│   │   ├── buttons_component.py
│   │   ├── enums.py         # Template categories, types, formats
│   │   └── order_models.py  # Order-related models (checkout templates)
│   └── validators/
│       ├── create/          # 12 template creation validators
│       └── send/            # 11 template send validators
├── tests/
│   ├── test_validators.py   # Validator tests
│   ├── test_meta_api.py     # API client tests (mocked HTTP)
│   └── test_tools.py        # MCP tool registration & helper tests
├── .env.example
├── requirements.txt
├── LICENSE                  # MIT
└── ROADMAP.md

Requirements

  • Python 3.10+
  • Meta WhatsApp Business Account
  • System User access token with whatsapp_business_messaging and whatsapp_business_management permissions

Dependencies

Package Purpose
mcp Model Context Protocol SDK
httpx Async HTTP client for Meta API
pydantic Payload validation
python-dotenv Environment config

Roadmap

See ROADMAP.md for planned features.

License

MIT — see LICENSE.


Built by Jina Connect — the WhatsApp Business CX platform.

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

jina_whatsapp_mcp-0.1.0.tar.gz (58.9 kB view details)

Uploaded Source

Built Distribution

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

jina_whatsapp_mcp-0.1.0-py3-none-any.whl (109.2 kB view details)

Uploaded Python 3

File details

Details for the file jina_whatsapp_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: jina_whatsapp_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 58.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for jina_whatsapp_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6047c17f6bef930f577bb31ba67d06f9d629a96a6e5f0b76989a75972e864964
MD5 8d5695efa41676ddca4667f785cf3991
BLAKE2b-256 2499193d5993ca8358a6c5cee39cb93c9db22b3ed622a67564ffe99cdafe2388

See more details on using hashes here.

File details

Details for the file jina_whatsapp_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jina_whatsapp_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a16d96bd4c6d9eb626518cb09946e3609b528e6eb79e862d78067f7d5151f9e7
MD5 1196624add91a067b7b8da32d9229a5d
BLAKE2b-256 1410d2a9fb13c2b0f8118b95d4ee6eecfb125f79b2b0e0952dda7cbd5883fb4a

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