Home / MCP / WhatsApp MCP Server

WhatsApp MCP Server

Provides a bridge between WhatsApp Web and AI models via MCP, with standalone and API client deployment options.

typescript

6stars

View on GitHub

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
    "mcpServers": {
        "wweb_api": {
            "url": "http://localhost:3001/api"
        }
    }
}

You can connect WhatsApp Web functionality to AI models using an MCP server that exposes WhatsApp actions through flexible transport modes. This server lets you run in standalone MCP mode or as a client to a WhatsApp API server, enabling automated interactions with WhatsApp via a standardized interface.

How to use

Start by choosing your deployment mode and then connect your MCP client to the server. You can run a standalone MCP server that talks directly to WhatsApp Web, or run an MCP server that connects to a dedicated WhatsApp API server. In either case, you will access WhatsApp actions (such as sending messages, retrieving chats, and managing groups) through the MCP interface, allowing your AI model to perform tasks programmatically.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

Install globally or use with npx to run the MCP server.

Install globally using npm:

npm install -g .

Or run directly with npx:

npx wweb-mcp

Optionally build a Docker image for easier deployment:

docker build . -t wweb-mcp:latest

Additional configurations and notes

You can run in different modes to suit your environment. The main modes are MCP standalone, MCP API client, and a standalone WhatsApp API server for REST access. Use the CLI options to switch modes, ports, and authentication settings.

Key defaults include the SSE transport on port 3002 and the HTTP API server on port 3001, though you can customize these values with command-line options.

Available tools

get_status

Check WhatsApp client connection status

send_message

Send messages to WhatsApp contacts with fields like number and message

search_contacts

Search for contacts by name or number

get_messages

Retrieve messages from a specific chat with optional limit

get_chats

Get a list of all WhatsApp chats

create_group

Create a new WhatsApp group with a name and participants

add_participants_to_group

Add participants to an existing group by groupId and participants

get_group_messages

Retrieve messages from a group by groupId with optional limit

send_group_message

Send a message to a specific group by groupId

search_groups

Search for groups by name, description, or member names

get_group_by_id

Get detailed information about a specific group by groupId