wappmcp
v0.3.8
Published
TypeScript stdio MCP server and CLI for WhatsApp Web.
Maintainers
Readme
wappmcp
wappmcp is an open-source WhatsApp Web CLI and stdio MCP server built on top of whatsapp-web.js, commander, and @modelcontextprotocol/sdk.
It lets MCP-compatible clients read WhatsApp data, send and manage messages, and optionally subscribe to incoming WhatsApp events through an MCP notification channel.
Highlights
- Exposes WhatsApp as an MCP server over stdio.
- Supports interactive configuration via
wappmcp configure. - Provides read tools for chats, contacts, messages, status, and account details.
- Includes mutating tools for sending, replying, reacting, editing, deleting, forwarding, and typing.
- Can emit incoming message events over an optional MCP notification channel.
- Stores local app data under
~/.wappmcp/.
Requirements
- Node.js
24+ - A local Chrome or Chromium installation that
puppeteercan launch
If browser auto-detection does not work in your environment, set either WAPPMCP_BROWSER_PATH or PUPPETEER_EXECUTABLE_PATH.
Installation
Use it without installing globally:
npx wappmcp configureOr with Bun:
bunx wappmcp configureIf you prefer a global install:
npm install -g wappmcpFor local development:
npm install
npm run build
npm run dev -- configureQuick Start
- Run the interactive configuration:
npx wappmcp configureThis lets you:
- connect WhatsApp (including QR scan when required)
- disconnect and remove local session data
- manage
allowlist.usersandallowlist.chats
Configuration is saved to:
~/.wappmcp/config.json- Start the MCP server:
npx wappmcp mcp- If your MCP host supports notifications and you want incoming WhatsApp events, enable channels:
npx wappmcp mcp --channelsThe server uses stdio, so it is meant to be launched by an MCP client or wrapper rather than browsed directly in a terminal.
CLI Usage
Configure
npx wappmcp configure
bunx wappmcp configureOpens an interactive configure UI (Ink) to manage WhatsApp connection and event allowlist:
- connect/disconnect session
Allowed usersAllowed chats
Allowed users/chats screens support live type-to-filter search. Large lists are shown in a 5-row scroll viewport, with Back kept as a persistent utility row.
Everything is persisted to:
~/.wappmcp/config.jsonSession data always lives at:
~/.wappmcp/profileMCP Server
npx wappmcp mcp
bunx wappmcp mcpStarts the stdio MCP server for the configured WhatsApp session.
Optional channel support:
npx wappmcp mcp --channelsMCP Tools
The server currently exposes these tools:
whatsapp_get_mewhatsapp_get_statuswhatsapp_list_chatswhatsapp_get_chatwhatsapp_get_chat_participantswhatsapp_get_chat_messageswhatsapp_search_messageswhatsapp_get_messagewhatsapp_list_contactswhatsapp_get_contactwhatsapp_search_contactswhatsapp_get_contact_lidwhatsapp_lookup_numberwhatsapp_send_messagewhatsapp_send_media_from_base64whatsapp_send_media_from_pathwhatsapp_reply_to_messagewhatsapp_react_to_messagewhatsapp_edit_messagewhatsapp_delete_messagewhatsapp_forward_messagewhatsapp_send_typing
Push Channel
When started with --channels, the server:
- advertises the experimental MCP capability
hooman/channel - advertises
hooman/userwith pathmeta.user - advertises
hooman/sessionwith pathmeta.session - advertises
hooman/threadwith pathmeta.thread - advertises
hooman/channel/permissionfor remote daemon approvals - emits
notifications/hooman/channelfor incoming WhatsAppmessageevents
If allowlist entries are configured, notifications/hooman/channel events are emitted only when either:
meta.session(chat ID) is inallowlist.chats, ormeta.user(sender ID) is inallowlist.users
When no allowlist is configured (or both arrays are empty), all inbound channel events are emitted.
Each notification includes:
content: a JSON-encoded event payloadmeta.source: alwayswhatsappmeta.user: the sender identity seed for the incoming messagemeta.session: the chat identity seed for the incoming messagemeta.thread: the WhatsApp message ID for the incoming message
The JSON-decoded content payload includes:
sourceselfmessagetext
If the incoming message or its quoted parent contains media, attachments are downloaded and included in the emitted event payload. Files are stored under ~/.wappmcp/attachments/.
When Hooman sends notifications/hooman/channel/permission_request, wappmcp posts the request back into the originating WhatsApp chat and waits for a reply to that exact message. Supported replies are yes, always, and no, which are relayed back over notifications/hooman/channel/permission.
Local Data
wappmcp stores local state under ~/.wappmcp/:
profile/for WhatsApp session dataconfig.jsonfor allowlist configurationattachments/for downloaded incoming media attachments.wwebjs_cache/for WhatsApp Web version cache data
Notes
- This project uses WhatsApp Web under the hood, so the first login must be completed by scanning a QR code.
- Some device metadata is unavailable on multi-device sessions.
- Incoming notification channels depend on MCP host support.
License
MIT. See LICENSE.
