WhatsApp Web MCP Setup & Guide
io.github.mario-andreschak/mcp-whatsapp-web · v1.2.0
WhatsApp MCP via web.js or browserless Baileys: messages, media, chats, groups and contacts
Copy the install config on this page first, then verify docs and permissions upstream.
Overview
WhatsApp MCP via web.js or browserless Baileys: messages, media, chats, groups and contacts WhatsApp Web MCP Server is a MCP Server listed from MCP Registry. Transports: stdio. This page includes an overview, setup tutorial, install commands, and use cases for Trae, Tongyi Lingma, Cursor, Claude Code, and VS Code.
Use cases
AgentHub Verified AvailabilityTested & Ready
Automated pipeline validated install commands, protocol & client compatibility
Copy by platform
Choose your platform
- Open or create .cursor/mcp.json in your project root
- Click Copy config and paste; merge only this mcpServers entry if others exist
- Replace <placeholders> in env with real secrets (see Environment variables below)
- Save, then Cmd+Shift+P → Reload Window
Pre-fill Environment Variables (Optional)
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Setup tutorial
- Open the WhatsApp Web MCP Server page and confirm this MCP Server (source: MCP Registry).
- Copy the Cursor, Claude Code, or VS Code snippet.
- Merge it into mcpServers and replace env placeholders with real secrets.
- Reload the window, then call the MCP tools from your agent chat.
Install commands
Install commands and setup steps are in the HTML so search engines and no-JS browsers can read them without running client JavaScript.
Claude Code (local)
- Install Claude Code CLI
- Copy the command below, replace <placeholders> with real env values, then run in terminal
- See Environment variables below if listed
claude mcp add mcp-whatsapp-web -- npx -y mcp-whatsapp-webCursor — .cursor/mcp.json (local)
- Open or create .cursor/mcp.json in your project root
- Click Copy config and paste; merge only this mcpServers entry if others exist
- Replace <placeholders> in env with real secrets (see Environment variables below)
- Save, then Cmd+Shift+P → Reload Window
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}VS Code — .vscode/mcp.json (local)
- Install GitHub Copilot in VS Code with MCP support
- Open or create .vscode/mcp.json in your project root
- Click Copy config and paste; merge only this mcpServers entry if others exist
- Replace <placeholders> in env with real secrets
- Save and Developer: Reload Window
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Claude Desktop — claude_desktop_config.json (local)
- Open Claude Desktop claude_desktop_config.json (see remote guide for paths)
- Click Copy config and merge under mcpServers
- Replace <placeholders> in env with real secrets
- Fully quit and restart Claude Desktop
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Trae — .trae/mcp.json (local)
- Trae → Settings → MCP, or edit .trae/mcp.json / global mcp.json
- Click Copy config and merge mcpServers
- Replace <placeholders> in env with real secrets
- Save and reload Trae
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Cherry Studio — MCP settings (local)
- Cherry Studio → Settings → MCP Servers → Add (STDIO)
- Or import JSON: click Copy config and merge mcpServers
- Replace <placeholders> in env; ensure Node.js / uv (npx, uvx) are installed
- Enable the server and check tools load
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Tongyi Lingma — MCP config (local)
- Lingma Settings → MCP → + → STDIO or config file
- Click Copy config and merge mcpServers
- Replace <placeholders> in env; need Node.js 18+ (npx) or uv (uvx)
- Confirm connected before using tools in agent chat
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Windsurf — mcp_config.json (local)
- Edit ~/.codeium/windsurf/mcp_config.json
- Click Copy config and merge mcpServers (stdio same as Cursor)
- Replace <placeholders> in env, save, refresh Cascade
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Cline — MCP Servers (local)
- Cline panel → Settings → MCP Servers
- Click Copy config and merge
- Replace <placeholders> in env, then save
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}WorkBuddy — .workbuddy/mcp.json (local)
- Edit ~/.workbuddy/mcp.json (user) or project .workbuddy/mcp.json
- Or Plugins → MCP Servers → Configure MCP and paste the JSON below
- Replace <placeholders> in env; on Windows prefer absolute paths for command/scripts
- Save, restart WorkBuddy, confirm connector status is green
{
"mcpServers": {
"mcp-whatsapp-web": {
"command": "npx",
"args": [
"-y",
"mcp-whatsapp-web"
]
}
}
}Troubleshooting & Common ErrorsFAQ
Common connection errors and verified fixes for WhatsApp Web MCP Server
Getting 'connection closed' or exit code 1 in Cursor / Claude Code for WhatsApp Web MCP Server?
Usually caused by missing runtime paths or IDE environment inheritance. Fix steps: 1. Verify Node.js 18+ (npx) or Python 3.10+ (uvx) is installed; 2. Run 'which npx' or 'which uvx' in terminal, and replace 'command' with absolute path; 3. Reload or restart the client window after modifying config.
# Check binary path in terminal: which npx node -v
Getting 'spawn npx ENOENT' or 'command not found'?
The editor background process does not inherit your full terminal PATH. Solution: Globally install the package, or set the absolute binary path (e.g. C:\Program Files\nodejs\npx.cmd on Windows, or /usr/local/bin/npx on macOS).
Missing required environment variable or authentication failure?
WhatsApp Web MCP Server requires environment variables (WHATSAPP_BACKEND、BAILEYS_SESSION_DIR、LOG_LEVEL、LOG_STDERR_LEVEL、WHATSAPP_HEADLESS、WHATSAPP_NO_SANDBOX、BROWSER_EXECUTABLE_PATH、WHATSAPP_SESSION_DIR、WHATSAPP_PAIRING_PHONE_NUMBER、FFMPEG_PATH、WA_WEB_VERSION、HEALTH_CHECK_INTERVAL_MS、TOOL_READY_TIMEOUT_MS、MCP_HTTP_PORT、MCP_HTTP_HOST、MCP_OAUTH). Ensure you have added valid keys under the 'env' object in your config file without trailing whitespace.
// .cursor/mcp.json 或 claude_desktop_config.json
{
"env": {
"API_KEY": "your_actual_key_here"
}
}Tool Mock Playground
SandboxWhatsApp Web MCP Server Tool Interface Simulation · Preview tool schema & outputs without local runtime
{
"target": "WhatsApp Web MCP Server",
"action": "execute",
"options": {
"mode": "standard",
"timeoutMs": 5000
}
}Click 'Run Mock' above
to preview the raw response returned to the LLM
Decision Guide: Why & When to Use
Assess suitability before installing to save trial-and-error time
- PR review
- Changelog generation
- Cross-repo issue search
- Replacing human security audit
- Unauthorized repo access
WhatsApp Web MCP Server + Scenario Prompt → Complete Agent Automation
MCP hands-on: install to visible results
Follow the full lab (expected UI/output + contrast checks). After installing this item, verify with the tutorial prompts.
Related resources
顺序思考
io.mcp-cn.modelcontextprotocol/server-sequential-thinking
帮助AI进行结构化思考和推理的MCP工具
n8n
io.mcp-cn.drballs/n8n-mcp-server
n8n工作流自动化平台的MCP服务器,提供完整的工作流管理、执行控制、凭证管理等功能
Playwright
io.mcp-cn.playwright/mcp
基于Playwright的自动化测试和网页操作MCP工具
GitHub
io.mcp-cn.modelcontextprotocol/server-github
连接GitHub的MCP服务器,支持仓库管理、问题跟踪、代码搜索等功能
高德地图
io.mcp-cn.amap/amap-maps-mcp-server
高德地图的MCP服务器
Figma
io.mcp-cn.figma-developer-mcp
连接Figma的MCP服务器,支持设计文件管理和操作
Often paired with
Planning with files
v3.23.0
io.clawhub.othmanadi/planning-with-files
Persistent file-based planning for multi-step AI-agent work. Keeps task_plan.md, findings.md, and progress.md on disk; lifecycle hooks inject selected project planning context. Automatic recovery reads project planning files only. Explicit session-catchup.py --metadata reads same-project local agent session records and emits aggregate counts only; --replay may emit bounded nonce-framed excerpts. Optional gated mode can request continuation only when the host supports it and never runs commands declared in Markdown. The skill has no network upload path. Use for research or work needing 5+ tool calls.
OpenClaw Command Center
v1.5.0
io.clawhub.jontsai/command-center
Mission control dashboard for OpenClaw - real-time session monitoring, LLM usage tracking, cost intelligence, and system vitals. View all your AI agents in one place.
ClawCall
v2.0.1
io.clawhub.clawcall-dev/clawcall-dev
Use when the user wants an AI agent to place a US phone call, call a business, handle hold or phone menus, confirm/reschedule/cancel/book/follow up/check an order, reach a real person, leave voicemail, connect the user into a live call, configure ClawCall voice/personality/profile or inbound reserved-number answering, poll received inbound calls, or link a ClawCall API key. Not for SMS, email, or international calls.
中文公文写作
v2.0.25
io.clawhub.gongyu0918-debug/chinese-official-writing
用于中文公文、事务性材料和新闻稿件的起草、改写、压缩、润色、审校、文种核对、去口语化、降 AI 味及 Word 格式处理,适用于机关、企事业单位、学校和新闻机构。涵盖申请、请示、报告、通知、通告、意见、决定、决议、议案、公报、命令、函、复函、批复、说明、方案、纪要、公告、公示、通报、制度、规定、办法、细则、操作规程、工作要点、总结、调研、讲话、致辞、主持词、述职、可研、审查材料、技术需求、新闻消息、编者按、新闻评论,以及采购、整改、反馈和 AI 算力等场景。
Keep exploring AgentHub
Most people compare similar tools or check scenario guides before installing—start here.
Listing badge: put AgentHub on your site
Copy either snippet into your project homepage, docs, or GitHub README. The badge is a hotlinked SVG — nothing to host — and it links back to this page so visitors can find the install steps.
<a href="https://myagenthub.cn/p/io.github.mario-andreschak/mcp-whatsapp-web" title="Listed on AgentHub: WhatsApp Web MCP Server" target="_blank" rel="noopener">
<img src="https://myagenthub.cn/badge/io.github.mario-andreschak/mcp-whatsapp-web?lang=en" alt="Listed on AgentHub: WhatsApp Web MCP Server" height="20" style="border:0"/>
</a>[](https://myagenthub.cn/p/io.github.mario-andreschak/mcp-whatsapp-web)Badges are generated on the fly from /badge/<package-id>, so name and listing changes propagate automatically. Keep the link target unchanged — it is what counts as the referral.
Unified Manifest
{
"id": "io.github.mario-andreschak/mcp-whatsapp-web",
"type": "mcp-server",
"version": "1.2.0",
"displayName": "WhatsApp Web MCP Server",
"description": "WhatsApp MCP via web.js or browserless Baileys: messages, media, chats, groups and contacts",
"repository": {
"url": "https://github.com/mario-andreschak/mcp-whatsapp-web",
"source": "github"
},
"homepage": "https://github.com/mario-andreschak/mcp-whatsapp-web",
"distribution": {
"packages": [
{
"registryType": "npm",
"identifier": "mcp-whatsapp-web",
"version": "1.2.0",
"runtimeHint": "npx",
"transport": "stdio",
"environmentVariables": [
{
"name": "WHATSAPP_BACKEND",
"description": "WhatsApp backend: webjs uses a persistent browser profile; baileys connects without a browser and requires separate pairing"
},
{
"name": "BAILEYS_SESSION_DIR",
"description": "Baileys credentials and synchronized history directory (default: <working directory>/baileys-sessions). Use a private absolute path, owned by one server process."
},
{
"name": "LOG_LEVEL",
"description": "Log level for the log file (logs/mcp-whatsapp.log)"
},
{
"name": "LOG_STDERR_LEVEL",
"description": "Log level for stderr (visible in most MCP client logs)"
},
{
"name": "WHATSAPP_HEADLESS",
"description": "webjs only: set to false to show the browser window instead of running headless"
},
{
"name": "WHATSAPP_NO_SANDBOX",
"description": "webjs only: explicitly disable the browser sandbox for containers that require it. The sandbox is enabled by default."
},
{
"name": "BROWSER_EXECUTABLE_PATH",
"description": "webjs only: browser executable. Chrome and Edge are auto-detected; set this to use a specific browser. Chrome/Edge is required for sending videos and GIFs."
},
{
"name": "WHATSAPP_SESSION_DIR",
"description": "webjs only: persistent browser profile directory (default: <working directory>/whatsapp-sessions)"
},
{
"name": "WHATSAPP_PAIRING_PHONE_NUMBER",
"description": "Phone number pairing: when set (international, symbol-free format, e.g. 4915112345678), an 8-character pairing code is logged to stderr on startup instead of relying on the QR code"
},
{
"name": "FFMPEG_PATH",
"description": "Path to an ffmpeg binary (only needed to override the ffmpeg installed automatically via the ffmpeg-static npm package)"
},
{
"name": "WA_WEB_VERSION",
"description": "webjs only: pin the WhatsApp Web version if a WhatsApp-side update breaks the client."
},
{
"name": "HEALTH_CHECK_INTERVAL_MS",
"description": "webjs only: connection health check interval in milliseconds (<=0 disables)"
},
{
"name": "TOOL_READY_TIMEOUT_MS",
"description": "How long tool calls wait for the WhatsApp client to become ready before erroring"
},
{
"name": "MCP_HTTP_PORT",
"description": "When set, additionally exposes the MCP endpoint at http://127.0.0.1:<port>/mcp (Streamable HTTP) from the same process"
},
{
"name": "MCP_HTTP_HOST",
"description": "Bind address for the HTTP endpoint (do not expose publicly; the endpoint controls your personal WhatsApp account)"
},
{
"name": "MCP_OAUTH",
"description": "Enable OAuth for the HTTP endpoint: /mcp requires a bearer token and clients authenticate via a browser page showing the WhatsApp QR code / pairing form"
}
]
}
],
"remotes": []
},
"dependencies": [],
"installTargets": [
"claude-code",
"claude-desktop",
"cursor",
"vscode",
"trae",
"cherry-studio",
"lingma",
"windsurf",
"cline",
"workbuddy"
],
"keywords": [],
"provenance": {
"origin": "official-mcp-registry",
"originalId": "io.github.mario-andreschak/mcp-whatsapp-web",
"originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.mario-andreschak%2Fmcp-whatsapp-web/versions/latest",
"isOfficial": true,
"status": "active"
}
}