返回市场
WhatsApp-MCP-服务器

WhatsApp-MCP-服务器

作者:piyushgupta534 星标更新:2025-03-23

项目介绍

WhatsApp MCP 服务器

使用模型上下文协议(MCP)SDK 实现的 WhatsApp 服务器。此服务器通过 GreenAPI 服务提供与 WhatsApp 交互的标准接口。

功能

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

预备条件

  • Node.js(v14 或更高版本)
  • npm 或 yarn
  • GreenAPI 账户及凭证

安装

  1. 克隆仓库:
git clone <repository-url>
cd whatsapp-mcp-server
  1. 安装依赖:
npm install

配置

服务器需要以下环境变量:

  • GREENAPI_API_URL:GreenAPI 服务的基础 URL
  • GREENAPI_API_TOKEN:您的 GreenAPI API 密钥

使用方法

  1. 启动服务器:
npm start
  1. 服务器将开始通过标准输入/输出监听 MCP 协议消息。

可用工具

打开会话

使用 GreenAPI 凭证打开一个新的 WhatsApp 会话。

参数:

  • sessionId:唯一会话 ID
  • instanceId:GreenAPI 实例 ID
  • apiTokenInstance:GreenAPI API 密钥

发送消息

向指定聊天发送消息。

参数:

  • sessionId:来自 open_session 的会话 ID
  • chatId:接收者聊天 ID(例如,1234567890@c.usgroup@g.us
  • message:要发送的消息

获取聊天列表

检索可用的聊天列表。

参数:

  • sessionId:来自 open_session 的会话 ID

创建群组

创建一个新的 WhatsApp 群组。

参数:

  • sessionId:来自 open_session 的会话 ID
  • groupName:要创建的群组名称
  • participants:带有域的电话号码数组(例如 12345@c.us

获取聊天历史

从指定聊天(个人或群组)中检索最近的消息。

参数:

  • sessionId:来自 open_session 的会话 ID
  • chatId:要检索消息的聊天 ID(例如,1234567890@c.usgroup@g.us
  • count:要检索的消息数量(默认:50)

重要:为了在聊天历史记录中接收传入消息,您需要使用 SetSettings 方法或通过 GreenAPI 控制台启用“接收传入消息和文件的 webhook”设置。如果没有启用此设置,聊天历史记录将仅显示传出消息。

发送文件

向指定聊天发送文件。

参数:

  • sessionId:来自 open_session 的会话 ID
  • chatId:WhatsApp 聊天 ID(例如,1234567890@c.us
  • fileUrl:要发送的文件的公共 URL
  • fileName:(可选)接收者看到的文件名
  • caption:(可选)显示在文件下方的说明文字

添加参与者

将参与者添加到现有的 WhatsApp 群组。

参数:

  • sessionId:来自 open_session 的会话 ID
  • groupId:WhatsApp 群组 ID(例如,group@g.us
  • participantChatId:要添加的参与者的聊天 ID(例如,1234567890@c.us

移除参与者

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

参数:

  • sessionId:来自 open_session 的会话 ID
  • groupId:WhatsApp 群组 ID(例如,group@g.us
  • participantChatId:要移除的参与者的聊天 ID(例如,1234567890@c.us