Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| PYTHONPATH | Yes | Path to the src directory of the project, required for the Python interpreter to find the whatsapp_mcp package. | |
| WHATSAPP_HEADLESS | No | Whether to run the browser in headless mode. Set to 'false' to show the browser window for scanning the QR code. | false |
| WHATSAPP_PROFILE_DIR | Yes | Absolute path to the directory where the WhatsApp Web session profile (e.g., authentication data) will be persisted. |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_auth_status | Open WhatsApp Web if needed and report whether login is complete. |
| wait_until_ready | Wait until WhatsApp Web is fully authenticated and ready for use. |
| list_recent_chats | List the most recent chats visible in WhatsApp Web. |
| send_message | Send a WhatsApp message using either a phone number or an existing chat name. |
| get_recent_messages | Read recent messages from a chat identified by either a phone number or a chat name. |
| shutdown_browser | Close the browser context and stop the WhatsApp automation session. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |