er that exposes WhatsApp functionality through REST endpoints: ```bash npx wweb-mcp --mode whatsapp-api --api-port 3001 ``` #### MCP Server (Standalone) Run an MCP server that directly connects to WhatsApp Web: ```bash npx wweb-mcp --mode mcp --mcp-mode standalone --transport sse --sse-port 3002 ``` #### MCP Server (API Client) Run an MCP server that connects to the WhatsApp API server: ```bash # First, start the WhatsApp API server and note the API key from the logs npx wweb-mcp --mode whatsapp-api --api-port 3001 # Then, start the MCP server with the API key npx wweb-mcp --mode mcp --mcp-mode api --api-base-url http://localhost:3001/api --api-key YOUR_API_KEY --transport sse --sse-port 3002 ``` ### Available Tools | Tool | Description | Parameters | |------|-------------|------------| | `get_status` | Check WhatsApp client connection status | None | | `send_message` | Send messages to WhatsApp contacts | `number`: Phone number to send to
`message`: Text content to send | | `search_contacts` | Search for contacts by name or number | `query`: Search term to find contacts | | `get_messages` | Retrieve messages from a specific chat | `number`: Phone number to get messages from
`limit` (optional): Number of messages to retrieve | | `get_chats` | Get a list of all WhatsApp chats | None | | `create_group` | Create a new WhatsApp group | `name`: Name of the group
`participants`: Array of phone numbers to add | | `add_participants_to_group` | Add participants to an existing group | `groupId`: ID of the group
`participants`: Array of phone numbers to add | | `get_group_messages` | Retrieve messages from a group | `groupId`: ID of the group
`limit` (optional): Number of messages to retrieve | | `send_group_message` | Send a message to a group | `groupId`: ID of the group
`message`: Text content to send | | `search_groups` | Search for groups by name, description, or member names | `query`: Search term to find groups | | `get_group_by_id` | Get detailed information about a specific group | `groupId`: ID of the group to get | | `download_media_from_message` | Download media from a message | `messageId`: ID of the message containing media to download | | `send_media_message` | Send a media message to a WhatsApp contact | `number`: Phone number to send to
`source`: Media source with URI scheme (use `http://` or `https://` for URLs, `file://` for local files)
`caption` (optional): Text caption for the media | ### Available Resources | Resource URI | Description | |--------------|-------------| | `whatsapp://contacts` | List of all WhatsApp contacts | | `whatsapp://messages/{number}` | Messages from a specific chat | | `whatsapp://chats` | List of all WhatsApp chats | | `whatsapp://groups` | List of all WhatsApp groups | | `whatsapp://groups/search` | Search for groups by name, description, or member names | | `whatsapp://groups/{groupId}/messages` | Messages from a specific group | ### REST API Endpoints #### Contacts & Messages | Endpoint | Method | Description | Parameters | |----------|--------|-------------|------------| | `/api/status` | GET | Get WhatsApp connection status | None | | `/api/contacts` | GET | Get all contacts | None | | `/api/contacts/search` | GET | Search for contacts | `query`: Search term | | `/api/chats` | GET | Get all chats | None | | `/api/messages/{number}` | GET | Get messages from a chat | `limit` (query): Number of messages | | `/api/send` | POST | Send a message | `number`: Recipient
`message`: Message content | | `/api/send/media` | POST | Send a media message | `number`: Recipient
`source`: Media source with URI scheme (use `http://` or `https://` for URLs, `file://` for local files)
`caption` (optional): Text caption | | `/api/messages/{messageId}/media/download` | POST | Download media from a message | None | #### Group Management | Endpoint | Method | Description | Parameters | |----------|--------|-------------|------------| | `/api/groups` | GET | Get all groups | None | | `/api/groups/search` | GET | Search for groups | `query`: Search term |

WhatsApp Web MCP

Comments