WhatsApp MCP Server

WhatsApp MCP 服务

这是一个使用 Model Context Protocol（MCP）SDK 实现的 WhatsApp 服务。该服务通过 GreenAPI 服务提供与 WhatsApp 交互的标准化接口。

功能

• WhatsApp 会话管理
• 与 GreenAPI 服务集成
• 标准化 MCP 协议实现
• 支持 TypeScript

先决条件

• Node.js（v14 或更高版本）
• npm 或 yarn
• GreenAPI 账户和凭据

安装

1. 克隆仓库：

git clone <repository-url>
cd whatsapp-mcp-server

2. 安装依赖：

npm install

配置

服务需要以下环境变量：

• GREENAPI_API_URL：GreenAPI 服务的基础 URL
• GREENAPI_API_TOKEN：你的 GreenAPI API 令牌

用法

1. 启动服务：

npm start

2. 服务将通过标准输入/输出开始监听 MCP 协议消息。

可用工具

打开会话

使用 GreenAPI 凭据打开新的 WhatsApp 会话。

参数：

• sessionId：唯一的会话 ID
• instanceId：GreenAPI 实例 ID
• apiTokenInstance：GreenAPI API 令牌

发送消息

向指定聊天发送消息。

参数：

• sessionId：来自 open_session 的会话 ID
• chatId：收件人聊天 ID（例如，[email protected] 或 [email protected]）
• message：要发送的消息

获取聊天列表

获取可用聊天列表。

参数：

• sessionId：来自 open_session 的会话 ID

创建群组

创建新的 WhatsApp 群组。

参数：

• sessionId：来自 open_session 的会话 ID
• groupName：要创建的群组名称
• participants：带域名的电话号码数组（例如，[email protected]）

获取聊天记录

获取指定聊天（个人或群组）的近期消息。

参数：

• sessionId：来自 open_session 的会话 ID
• chatId：要获取消息的聊天 ID（例如，[email protected] 或 [email protected]）
• count：要获取的消息数量（默认值：50）

重要：若要在聊天记录中接收收到的消息，需要通过 SetSettings 方法或 GreenAPI 控制台启用“接收收到的消息和文件的 Webhook”设置。若未启用此设置，聊天记录中只会显示发出的消息。

发送文件

向指定聊天发送文件。

参数：

• sessionId：来自 open_session 的会话 ID
• chatId：WhatsApp 聊天 ID（例如，[email protected]）
• fileUrl：要发送文件的公开 URL
• fileName：（可选）收件人看到的文件名称
• caption：（可选）显示在文件下方的说明文字

添加参与者

向现有 WhatsApp 群组添加参与者。

参数：

• sessionId：来自 open_session 的会话 ID
• groupId：WhatsApp 群组的 ID（例如，[email protected]）
• participantChatId：要添加参与者的聊天 ID（例如，[email protected]）

移除参与者

从现有 WhatsApp 群组移除参与者。

参数：

• sessionId：来自 open_session 的会话 ID
• groupId：WhatsApp 群组的 ID（例如，[email protected]）
• participantChatId：要移除参与者的聊天 ID（例如，[email protected]）