关键词

WhatsApp API消息发送群组管理自动化社交

WhatsApp MCP 服务器使用说明

项目简介

WhatsApp MCP Server 是一个使用 Python 开发的 MCP 服务器，它允许大型语言模型 (LLM) 通过标准的 Model Context Protocol (MCP) 协议与 WhatsApp Business API 进行交互。通过这个服务器，LLM 可以实现发送 WhatsApp 消息、管理群组、获取联系人列表等功能。

主要功能点

  • 身份验证: 支持通过扫描二维码或API密钥进行 WhatsApp 身份验证。
  • 消息功能: 支持发送文本、媒体、位置等多种类型的 WhatsApp 消息。
  • 群组管理: 支持创建和管理 WhatsApp 群组，包括添加和移除成员。
  • 会话管理: 支持创建、恢复和管理多个 WhatsApp 会话。
  • 信息获取: 支持获取 WhatsApp 聊天列表和群组成员列表。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/msaelices/whatsapp-mcp-server.git
  2. 进入仓库目录: 
    cd whatsapp-mcp-server
  3. 安装依赖: 
    pip install -e .
  4. 配置环境变量:
    • 复制 '.env-template' 文件为 '.env'： 
      cp .env-template .env
    • 编辑 '.env' 文件，填入你的 GreenAPI 凭据 ('GREENAPI_ID_INSTANCE' 和 'GREENAPI_API_TOKEN')。

      注意: 你需要先设置 WhatsApp Business API 凭据。请参考 WhatsApp Business API 文档 获取必要的凭据。

服务器配置

MCP 客户端需要以下配置信息来启动和连接 WhatsApp MCP 服务器。将以下 JSON 配置添加到你的 MCP 客户端配置中：

{
  "serverName": "whatsapp",
  "command": "whatsapp-mcp",
  "args": []
}
  • 'serverName': 服务器的名称，可以自定义，用于在 MCP 客户端中标识该服务器。这里设置为 "whatsapp"。
  • 'command': 启动 MCP 服务器的命令。这里是 'whatsapp-mcp'，这是在安装时通过 'entry_points' 配置的命令行入口。
  • 'args': 启动命令的参数列表。这里为空列表，表示不使用任何额外的命令行参数。如果需要开启调试模式，可以添加 '--debug' 参数，例如 '["--debug"]'。

基本使用方法

  1. 启动服务器: 在安装完成后，运行以下命令启动 WhatsApp MCP 服务器：

    whatsapp-mcp

    如果需要查看调试信息，可以使用以下命令：

    whatsapp-mcp --debug

  2. MCP 客户端交互: 启动服务器后，MCP 客户端（如 Claude）可以通过 MCP 协议与之通信。你可以使用自然语言指令，例如：

    • 登录 WhatsApp: 'Login to WhatsApp'
    • 发送消息: 'Send the message "Hello" to John Doe'

    来指示 LLM 调用 WhatsApp MCP 服务器提供的工具，完成相应的 WhatsApp 操作。

可用工具 (Tools)

服务器提供以下工具，供 LLM 客户端调用：

  • 'create_session': 创建一个新的 WhatsApp 会话。
  • 'get_qr_code': 获取用于身份验证的二维码。
  • 'authenticate': 使用二维码进行身份验证。
  • 'logout': 登出当前会话。
  • 'send_message': 发送消息到指定的聊天。
  • 'get_chats': 获取聊天列表。
  • 'create_group': 创建新的 WhatsApp 群组。
  • 'get_group_participants': 获取群组成员列表。

更多工具的详细使用方法，请参考 MCP 客户端的文档。

信息

分类

通信与社交

访问项目