WhatsApp Web MCP

WhatsApp Web MCP

site icon
2025.04.13 18
TypeScriptWhatsApp 自动化AI 集成消息处理群组管理交流协作
WhatsApp Web MCP 是一个基于 Node.js 的应用,通过 Model Context Protocol (MCP) 将 WhatsApp Web 与 AI 模型连接起来。它提供了一个标准化的接口,用于通过 AI 驱动的工作流程实现自动化的消息发送、联系人管理和群聊功能。
View on GitHub

Overview

基本能力

产品定位

WhatsApp Web MCP 是一个中间件,旨在通过标准化的 MCP 协议将 WhatsApp Web 的功能与 AI 模型集成,实现自动化消息处理和群组管理。

核心功能

  • 提供 WhatsApp Web 的标准接口
  • 支持 MCP 服务器访问 WhatsApp 功能
  • 提供灵活的部署选项(SSE 或命令模式)
  • 支持直接 WhatsApp 客户端集成和基于 API 的连接
  • 消息发送和接收
  • 从消息下载媒体(图片、音频、文档)
  • 群聊管理
  • 联系人管理和搜索
  • 消息历史检索

适用场景

  • AI 驱动的自动化消息处理
  • 群组管理和自动化
  • 联系人管理和搜索
  • 消息历史分析和检索

工具列表

工具 描述
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 获取特定群组的详细信息
download_media_from_message 从消息中下载媒体

常见问题解答

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

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm
  2. 确保已安装 Git

安装教程

  1. 克隆仓库: bash git clone https://github.com/pnizer/wweb-mcp.git cd wweb-mcp

  2. 全局安装或使用 npx: ```bash # 全局安装 npm install -g .

# 或直接使用 npx npx . ```

  1. 使用 Docker 构建: bash docker build . -t wweb-mcp:latest

调试方式

  1. 运行 WhatsApp API 服务器: bash npx wweb-mcp --mode whatsapp-api --api-port 3001

  2. 运行 MCP 服务器(独立模式): bash npx wweb-mcp --mode mcp --mcp-mode standalone --transport sse --sse-port 3002

  3. 运行 MCP 服务器(API 客户端模式): bash npx wweb-mcp --mode mcp --mcp-mode api --api-base-url http://localhost:3001/api --api-key YOUR_API_KEY --transport sse --sse-port 3002

  4. 检查日志级别: bash npm start -- --log-level=debug

许可证

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