WhatsApp Web MCP Server
mcpkey · packageWhatsApp MCP via web.js or browserless Baileys: messages, media, chats, groups and contacts
run it
on your own machines, one way per deploy method# once, as root:
# as_mcp DIR COMMAND...: runs COMMAND as the mcp user in DIR, its home, sandboxed as the
# units are: a package's install scripts can write to DIR only, as the server later can
as_mcp() {
local dir="$1"; shift
systemd-run --quiet --wait --pipe --collect --uid=mcp --gid=mcp \
-p WorkingDirectory="$dir" -p Environment=HOME="$dir" -p ReadWritePaths="$dir" \
-p NoNewPrivileges=true -p ProtectSystem=strict -p ProtectHome=true -p PrivateTmp=true \
-- "$@" </dev/null
}
install -d -m 0750 -o mcp -g mcp /var/lib/mcp/whatsapp-web
# whatsapp-web: its packages, installed whole before its unit starts (no session installs)
# npx takes a half-installed tree for installed: a rerun starts them afresh
systemctl stop mcp-my-agent-whatsapp-web.service 2>/dev/null || true
as_mcp /var/lib/mcp/whatsapp-web rm -rf /var/lib/mcp/whatsapp-web/.npm/_npx
as_mcp /var/lib/mcp/whatsapp-web npx --yes [email protected] -- true
as_mcp /var/lib/mcp/whatsapp-web npx --yes --package=supergateway@4 -- true
#!/usr/bin/env bash
# whatsapp-web (io.github.mario-andreschak/mcp-whatsapp-web), recipe baremetal (generated).
# Generated by Hub for toolset "my-agent"; started by mcp-my-agent-whatsapp-web.service.
set -euo pipefail
export HOST=127.0.0.1 PORT=8101
exec npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp --stateful --host 127.0.0.1 --port 8101 --streamableHttpPath /mcp --healthEndpoint /healthz
[Unit]
Description=MCP server whatsapp-web (toolset my-agent), generated by Hub
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=mcp
Group=mcp
EnvironmentFile=/etc/mcp/my-agent.env
Environment=HOME=/var/lib/mcp/whatsapp-web
WorkingDirectory=/var/lib/mcp/whatsapp-web
ExecStart=/opt/mcp/my-agent/bin/whatsapp-web.sh
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
PrivateTmp=true
ReadWritePaths=/var/lib/mcp/whatsapp-web
[Install]
WantedBy=multi-user.target
docker run --rm -p 127.0.0.1:8101:8000 -e WHATSAPP_BACKEND -e BAILEYS_SESSION_DIR -e LOG_LEVEL -e LOG_STDERR_LEVEL -e WHATSAPP_HEADLESS -e WHATSAPP_NO_SANDBOX -e BROWSER_EXECUTABLE_PATH -e WHATSAPP_SESSION_DIR -e WHATSAPP_PAIRING_PHONE_NUMBER -e FFMPEG_PATH -e WA_WEB_VERSION -e HEALTH_CHECK_INTERVAL_MS -e TOOL_READY_TIMEOUT_MS -e MCP_HTTP_PORT -e MCP_HTTP_HOST -e MCP_OAUTH node:22-alpine sh -c 'npx -y supergateway@4 --stdio '"'"'npx -y [email protected]'"'"' --outputTransport streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz'
# Generated by Hub for toolset "my-agent" (2026-10-18T20:53:49+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
whatsapp-web:
image: node:22-alpine
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp --stateful
--host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
ports:
- 127.0.0.1:8101:8000
volumes:
- npm-cache:/root/.npm
healthcheck:
test:
- CMD-SHELL
- wget -qO- http://127.0.0.1:8000/healthz || exit 1
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
WHATSAPP_BACKEND: ${WHATSAPP_BACKEND}
BAILEYS_SESSION_DIR: ${BAILEYS_SESSION_DIR}
LOG_LEVEL: ${LOG_LEVEL}
LOG_STDERR_LEVEL: ${LOG_STDERR_LEVEL}
WHATSAPP_HEADLESS: ${WHATSAPP_HEADLESS}
WHATSAPP_NO_SANDBOX: ${WHATSAPP_NO_SANDBOX}
BROWSER_EXECUTABLE_PATH: ${BROWSER_EXECUTABLE_PATH}
WHATSAPP_SESSION_DIR: ${WHATSAPP_SESSION_DIR}
WHATSAPP_PAIRING_PHONE_NUMBER: ${WHATSAPP_PAIRING_PHONE_NUMBER}
FFMPEG_PATH: ${FFMPEG_PATH}
WA_WEB_VERSION: ${WA_WEB_VERSION}
HEALTH_CHECK_INTERVAL_MS: ${HEALTH_CHECK_INTERVAL_MS}
TOOL_READY_TIMEOUT_MS: ${TOOL_READY_TIMEOUT_MS}
MCP_HTTP_PORT: ${MCP_HTTP_PORT}
MCP_HTTP_HOST: ${MCP_HTTP_HOST}
MCP_OAUTH: ${MCP_OAUTH}
volumes:
npm-cache: {}
uv-cache: {}
# Generated by Hub for toolset "my-agent" (2026-10-18T20:53:49+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: whatsapp-web
namespace: mcp
labels: &id001
app: whatsapp-web
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: whatsapp-web
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: WHATSAPP_BACKEND
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_BACKEND
- name: BAILEYS_SESSION_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BAILEYS_SESSION_DIR
- name: LOG_LEVEL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: LOG_LEVEL
- name: LOG_STDERR_LEVEL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: LOG_STDERR_LEVEL
- name: WHATSAPP_HEADLESS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_HEADLESS
- name: WHATSAPP_NO_SANDBOX
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_NO_SANDBOX
- name: BROWSER_EXECUTABLE_PATH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BROWSER_EXECUTABLE_PATH
- name: WHATSAPP_SESSION_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_SESSION_DIR
- name: WHATSAPP_PAIRING_PHONE_NUMBER
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_PAIRING_PHONE_NUMBER
- name: FFMPEG_PATH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: FFMPEG_PATH
- name: WA_WEB_VERSION
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WA_WEB_VERSION
- name: HEALTH_CHECK_INTERVAL_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: HEALTH_CHECK_INTERVAL_MS
- name: TOOL_READY_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TOOL_READY_TIMEOUT_MS
- name: MCP_HTTP_PORT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_HTTP_PORT
- name: MCP_HTTP_HOST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_HTTP_HOST
- name: MCP_OAUTH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_OAUTH
args:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: whatsapp-web
namespace: mcp
spec:
selector:
app: whatsapp-web
ports:
- port: 8000
targetPort: http
name: http
# Generated by Hub for toolset "my-agent" (2026-10-18T20:53:49+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
whatsapp-web:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: whatsapp-web
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: WHATSAPP_BACKEND
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_BACKEND
- name: BAILEYS_SESSION_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BAILEYS_SESSION_DIR
- name: LOG_LEVEL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: LOG_LEVEL
- name: LOG_STDERR_LEVEL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: LOG_STDERR_LEVEL
- name: WHATSAPP_HEADLESS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_HEADLESS
- name: WHATSAPP_NO_SANDBOX
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_NO_SANDBOX
- name: BROWSER_EXECUTABLE_PATH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BROWSER_EXECUTABLE_PATH
- name: WHATSAPP_SESSION_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_SESSION_DIR
- name: WHATSAPP_PAIRING_PHONE_NUMBER
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WHATSAPP_PAIRING_PHONE_NUMBER
- name: FFMPEG_PATH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: FFMPEG_PATH
- name: WA_WEB_VERSION
valueFrom:
secretKeyRef:
name: mcp-credentials
key: WA_WEB_VERSION
- name: HEALTH_CHECK_INTERVAL_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: HEALTH_CHECK_INTERVAL_MS
- name: TOOL_READY_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TOOL_READY_TIMEOUT_MS
- name: MCP_HTTP_PORT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_HTTP_PORT
- name: MCP_HTTP_HOST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_HTTP_HOST
- name: MCP_OAUTH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_OAUTH
args:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: 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. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsnpx -y [email protected] # env: 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
{
"mcpServers": {
"whatsapp-web": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"WHATSAPP_BACKEND": "${WHATSAPP_BACKEND}",
"BAILEYS_SESSION_DIR": "${BAILEYS_SESSION_DIR}",
"LOG_LEVEL": "${LOG_LEVEL}",
"LOG_STDERR_LEVEL": "${LOG_STDERR_LEVEL}",
"WHATSAPP_HEADLESS": "${WHATSAPP_HEADLESS}",
"WHATSAPP_NO_SANDBOX": "${WHATSAPP_NO_SANDBOX}",
"BROWSER_EXECUTABLE_PATH": "${BROWSER_EXECUTABLE_PATH}",
"WHATSAPP_SESSION_DIR": "${WHATSAPP_SESSION_DIR}",
"WHATSAPP_PAIRING_PHONE_NUMBER": "${WHATSAPP_PAIRING_PHONE_NUMBER}",
"FFMPEG_PATH": "${FFMPEG_PATH}",
"WA_WEB_VERSION": "${WA_WEB_VERSION}",
"HEALTH_CHECK_INTERVAL_MS": "${HEALTH_CHECK_INTERVAL_MS}",
"TOOL_READY_TIMEOUT_MS": "${TOOL_READY_TIMEOUT_MS}",
"MCP_HTTP_PORT": "${MCP_HTTP_PORT}",
"MCP_HTTP_HOST": "${MCP_HTTP_HOST}",
"MCP_OAUTH": "${MCP_OAUTH}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add whatsapp-web -e "WHATSAPP_BACKEND=${WHATSAPP_BACKEND}" -e "BAILEYS_SESSION_DIR=${BAILEYS_SESSION_DIR}" -e "LOG_LEVEL=${LOG_LEVEL}" -e "LOG_STDERR_LEVEL=${LOG_STDERR_LEVEL}" -e "WHATSAPP_HEADLESS=${WHATSAPP_HEADLESS}" -e "WHATSAPP_NO_SANDBOX=${WHATSAPP_NO_SANDBOX}" -e "BROWSER_EXECUTABLE_PATH=${BROWSER_EXECUTABLE_PATH}" -e "WHATSAPP_SESSION_DIR=${WHATSAPP_SESSION_DIR}" -e "WHATSAPP_PAIRING_PHONE_NUMBER=${WHATSAPP_PAIRING_PHONE_NUMBER}" -e "FFMPEG_PATH=${FFMPEG_PATH}" -e "WA_WEB_VERSION=${WA_WEB_VERSION}" -e "HEALTH_CHECK_INTERVAL_MS=${HEALTH_CHECK_INTERVAL_MS}" -e "TOOL_READY_TIMEOUT_MS=${TOOL_READY_TIMEOUT_MS}" -e "MCP_HTTP_PORT=${MCP_HTTP_PORT}" -e "MCP_HTTP_HOST=${MCP_HTTP_HOST}" -e "MCP_OAUTH=${MCP_OAUTH}" -- npx -y [email protected]
{
"mcpServers": {
"whatsapp-web": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"WHATSAPP_BACKEND": "${WHATSAPP_BACKEND}",
"BAILEYS_SESSION_DIR": "${BAILEYS_SESSION_DIR}",
"LOG_LEVEL": "${LOG_LEVEL}",
"LOG_STDERR_LEVEL": "${LOG_STDERR_LEVEL}",
"WHATSAPP_HEADLESS": "${WHATSAPP_HEADLESS}",
"WHATSAPP_NO_SANDBOX": "${WHATSAPP_NO_SANDBOX}",
"BROWSER_EXECUTABLE_PATH": "${BROWSER_EXECUTABLE_PATH}",
"WHATSAPP_SESSION_DIR": "${WHATSAPP_SESSION_DIR}",
"WHATSAPP_PAIRING_PHONE_NUMBER": "${WHATSAPP_PAIRING_PHONE_NUMBER}",
"FFMPEG_PATH": "${FFMPEG_PATH}",
"WA_WEB_VERSION": "${WA_WEB_VERSION}",
"HEALTH_CHECK_INTERVAL_MS": "${HEALTH_CHECK_INTERVAL_MS}",
"TOOL_READY_TIMEOUT_MS": "${TOOL_READY_TIMEOUT_MS}",
"MCP_HTTP_PORT": "${MCP_HTTP_PORT}",
"MCP_HTTP_HOST": "${MCP_HTTP_HOST}",
"MCP_OAUTH": "${MCP_OAUTH}"
}
}
}
}
{
"servers": {
"whatsapp-web": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"WHATSAPP_BACKEND": "${WHATSAPP_BACKEND}",
"BAILEYS_SESSION_DIR": "${BAILEYS_SESSION_DIR}",
"LOG_LEVEL": "${LOG_LEVEL}",
"LOG_STDERR_LEVEL": "${LOG_STDERR_LEVEL}",
"WHATSAPP_HEADLESS": "${WHATSAPP_HEADLESS}",
"WHATSAPP_NO_SANDBOX": "${WHATSAPP_NO_SANDBOX}",
"BROWSER_EXECUTABLE_PATH": "${BROWSER_EXECUTABLE_PATH}",
"WHATSAPP_SESSION_DIR": "${WHATSAPP_SESSION_DIR}",
"WHATSAPP_PAIRING_PHONE_NUMBER": "${WHATSAPP_PAIRING_PHONE_NUMBER}",
"FFMPEG_PATH": "${FFMPEG_PATH}",
"WA_WEB_VERSION": "${WA_WEB_VERSION}",
"HEALTH_CHECK_INTERVAL_MS": "${HEALTH_CHECK_INTERVAL_MS}",
"TOOL_READY_TIMEOUT_MS": "${TOOL_READY_TIMEOUT_MS}",
"MCP_HTTP_PORT": "${MCP_HTTP_PORT}",
"MCP_HTTP_HOST": "${MCP_HTTP_HOST}",
"MCP_OAUTH": "${MCP_OAUTH}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.mario-andreschak/mcp-whatsapp-web
- not probed yet: tools unpinned, ingest lists them