Whatsapp MCP Server Lne

🚀 WhatsApp MCP 服務器

WhatsApp MCP 服務器是一個藉助模型上下文協議（MCP）SDK 實現的服務器，它為通過 GreenAPI 服務與 WhatsApp 進行交互提供了標準化接口，極大地簡化了相關操作流程。

🚀 快速開始

要使用此服務器，你需要完成安裝和配置步驟，之後即可啟動服務器並使用其提供的各種工具。

✨ 主要特性

• WhatsApp 會話管理：高效管理 WhatsApp 會話，提升使用體驗。
• 集成 GreenAPI 服務：無縫對接 GreenAPI 服務，實現與 WhatsApp 的交互。
• 標準化 MCP 協議實現：遵循標準的 MCP 協議，確保通信的規範性。
• TypeScript 支持：採用 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（例如 1234567890@c.us 或 group@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.us 或 group@g.us）
• count：要檢索的消息數量（默認值：50）

⚠️ 重要提示

為了接收聊天中的 incoming 消息，你需要通過 SetSettings 方法或在 GreenAPI 控制檯啟用“Receive webhooks on incoming messages and files”設置。否則，聊天記錄中只會顯示 outgoing 消息。

發送文件

向指定聊天發送文件。 參數：

• 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）