WhatsApp (GreenAPI)

🚀 WhatsApp MCP 服务器

WhatsApp MCP 服务器提供模型上下文协议 (MCP) 接口，可借助 FastMCP 与 WhatsApp Business API 交互，让语言模型能与 WhatsApp 功能对接。

🚀 快速开始

WhatsApp MCP 服务器基于 Python 实现，能让如 Claude 这类语言模型通过 GreenAPI 与 WhatsApp 功能交互。它借助 FastMCP 提升性能、优化开发者体验并构建更简洁的代码结构。

✨ 主要特性

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

📦 安装指南

# 克隆仓库
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) 上运行 MCP 服务器
whatsapp-mcp

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

高级用法

用于调试：

# 使用 MCP 监视器进行调试
npx @modelcontextprotocol/inspector whatsapp-mcp

📚 详细文档

WhatsApp API 客户端

此项目使用 whatsapp-api-client-python 库与 WhatsApp 进行交互。该客户端提供对 WhatsApp 云 API 的访问，需要一个 GreenAPI 账户才能使用。

环境变量

该项目使用环境变量进行配置：

• GREENAPI_ID_INSTANCE：您的 GreenAPI 实例 ID
• GREENAPI_API_TOKEN：您的 GreenAPI API 令牌

您可以将这些变量设置在环境中，或使用提供的 .env 文件（请参阅安装说明）。

开发

# 安装开发依赖项
pip install -e ".[dev]"

# 运行测试
pytest

# 检查代码风格
flake8 src/

# 检查类型
mypy src/

该项目使用现代 pyproject.toml 配置，包括：

• 运行应用程序所需的依赖项
• 使用 pip install -e ".[dev]" 安装的开发依赖项

📄 许可证

此项目根据 MIT License 分发，详细信息请参阅 LICENSE 文件。