WhatsApp Web MCP

WhatsApp Web MCP

site icon
2025.03.26 3
TypeScriptWhatsApp 自动化AI 集成交流协作
WhatsApp Web MCP 是一个基于 Model Context Protocol (MCP) 的桥梁工具,用于连接 WhatsApp Web 和 AI 模型。它通过标准化的接口使 AI 模型(如 Claude)能够与 WhatsApp 进行交互,从而实现对 WhatsApp 的自动化操作和增强功能。
View on GitHub

Overview

基本能力

产品定位

WhatsApp Web MCP 是一个中间件工具,旨在通过标准化的 MCP 协议将 WhatsApp Web 的功能暴露给 AI 模型,实现自动化交互和功能增强。

核心功能

  • 提供标准化的 MCP 接口连接 WhatsApp Web 和 AI 模型
  • 支持多种部署模式(SSE 或 Command 模式)
  • 支持直接 WhatsApp 客户端集成和基于 API 的连接方式
  • 提供丰富的 WhatsApp 功能接口,包括消息发送、联系人搜索、群组管理等

适用场景

  • AI 模型与 WhatsApp 的自动化交互
  • 开发 WhatsApp 自动化工具
  • 构建基于 WhatsApp 的业务流程

工具列表

工具 描述
get_status 检查 WhatsApp 客户端连接状态
send_message 向 WhatsApp 联系人发送消息
search_contacts 按名称或号码搜索联系人
get_messages 从特定聊天中检索消息
get_chats 获取所有 WhatsApp 聊天列表
create_group 创建新的 WhatsApp 群组
add_participants_to_group 向现有群组添加参与者
get_group_messages 从群组中检索消息
send_group_message 向群组发送消息
search_groups 按名称、描述或成员名称搜索群组
get_group_by_id 获取特定群组的详细信息

常见问题解答

  • Claude Desktop 集成问题:由于 Claude 会打开多个进程,每个 wweb-mcp 需要打开一个不能共享相同 WhatsApp 认证的 puppeteer 会话,因此将应用拆分为 MCP 和 API 模式以支持与 Claude 的正确集成。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm
  2. 可选:安装 Docker(如需使用 Docker 部署)

安装教程

  1. 克隆仓库:
git clone https://github.com/pnizer/wweb-mcp.git
cd wweb-mcp
  1. 全局安装或使用 npx:
# 全局安装
npm install -g .

# 或直接使用 npx
npx .
  1. 使用 Docker 构建:
docker build . -t wweb-mcp:latest

调试方式

  1. 启动 WhatsApp API 服务器:
npx wweb-mcp --mode whatsapp-api --api-port 3001
  1. 启动 MCP 服务器(独立模式):
npx wweb-mcp --mode mcp --mcp-mode standalone --transport sse --sse-port 3002
  1. 检查日志中的 API 密钥并使用该密钥连接 MCP 服务器到 WhatsApp API 服务器。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。