WhatsApp MCP Server

WhatsApp MCP Server

site icon
2025.04.04 5
PythonWhatsApp 集成消息自动化群组管理交流协作
WhatsApp MCP Server 是一个基于 Python 实现的服务器,通过 Model Context Protocol (MCP) 接口与 WhatsApp Business API 进行交互。它利用 FastMCP 提供更好的性能、开发者体验和更清晰的实现。该服务器支持消息发送、群组管理、会话处理和聊天历史记录等功能,适用于需要通过 WhatsApp 进行自动化通信和管理的场景。
View on GitHub

Overview

基本能力

产品定位

WhatsApp MCP Server 是一个中间件服务器,旨在为语言模型(如 Claude)提供与 WhatsApp 功能交互的能力,通过 FastMCP 实现高性能的 API 接口。

核心功能

  • 消息发送:向 WhatsApp 联系人发送文本消息
  • 群组管理:创建群组、列出成员、添加/移除参与者
  • 会话处理:管理 WhatsApp API 会话
  • 聊天历史:获取聊天列表和消息历史记录

适用场景

  • 自动化 WhatsApp 消息发送
  • 管理 WhatsApp 群组
  • 集成 WhatsApp 功能到语言模型应用中
  • 开发基于 WhatsApp 的自动化工具

工具列表

  • open_session: 打开新的 WhatsApp 会话
  • send_message: 向聊天发送消息
  • get_chats: 获取聊天列表
  • create_group: 创建新的 WhatsApp 群组
  • get_group_participants: 获取群组参与者

常见问题解答

  • 需要 GreenAPI 账户才能使用 WhatsApp Cloud API
  • 通过环境变量 GREENAPI_ID_INSTANCEGREENAPI_API_TOKEN 配置 API 凭证
  • 可通过 .env 文件或直接设置环境变量来配置

使用教程

使用依赖

  • Python 环境
  • GreenAPI 账户

安装教程

# 克隆仓库
git clone https://github.com/yourusername/whatsapp-mcp-server.git
cd whatsapp-mcp-server

# 安装依赖
pip install -e .

# 设置环境变量
cp .env-template .env
# 编辑 .env 文件,填入您的 GreenAPI 凭证

调试方式

# 运行 MCP 服务器(默认主机 127.0.0.1,端口 8000)
whatsapp-mcp

# 指定主机和端口
whatsapp-mcp --host 0.0.0.0 --port 9000

# 调试模式
whatsapp-mcp --debug

API 参考

  • WebSocket: ws://localhost:8000/mcp
  • HTTP: http://localhost:8000/mcp

测试 API:

# 列出可用工具
curl -X POST http://localhost:8000/mcp/listTools

# 调用工具
curl -X POST http://localhost:8000/mcp/callTool \
  -H "Content-Type: application/json" \
  -d '{"name": "open_session", "arguments": {}}'

与 Claude 集成

# 添加 WhatsApp MCP 服务器
$ claude mcp add whatsapp -- whatsapp-mcp

# 列出现有 MCP 服务器 - 验证服务器是否运行
claude mcp list

# 启动 claude code
claude

许可证

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