关键词

WhatsApp集成消息历史联系人搜索消息发送聊天记录

使用说明

项目简介

本项目 'WhatsApp MCP服务器' 基于 Model Context Protocol (MCP) 构建，旨在为大型语言模型 (LLM) 应用提供访问和操作 WhatsApp 的能力。通过此服务器，LLM 可以获取 WhatsApp 消息历史、搜索联系人、发送消息等，从而实现更智能的 WhatsApp 应用集成。

主要功能点

  • 消息管理: 检索 WhatsApp 消息，支持按日期范围、发送者、聊天对象和关键词过滤，并能获取消息上下文。
  • 联系人查询: 根据名称或电话号码搜索 WhatsApp 联系人。
  • 聊天记录访问: 列出和检索 WhatsApp 聊天记录，包括群聊和私聊，并可获取最后一条消息。
  • 消息发送: 通过服务器向 WhatsApp 联系人或群组发送文本消息。

安装步骤

  1. 环境准备: 确保已安装 Go 语言环境 和 Python 3 环境。
  2. 下载仓库: 克隆 GitHub 仓库 'whatsapp-mcp' 到本地。 
    git clone https://github.com/Gh4stware/whatsapp-mcp.git
cd whatsapp-mcp
  3. 构建 WhatsApp Bridge (Go): 进入 'whatsapp-bridge' 目录，构建 Go 程序 'whatsapp-bridge'。 
    cd whatsapp-bridge
go build -o whatsapp-bridge main.go
cd ..
  4. 安装 Python 依赖: 进入 'whatsapp-mcp-server' 目录，安装 Python 依赖。 
    cd whatsapp-mcp-server
pip install -r requirements.txt
cd ..

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 WhatsApp MCP 服务器。

{
  "server_name": "whatsapp",
  "command": "python",
  "args": ["whatsapp-mcp-server/main.py"]
}
  • 'server_name': 服务器名称，可自定义，例如 "whatsapp"。
  • 'command': 运行服务器的命令，这里使用 'python'。
  • 'args': 命令参数，指定 Python 服务器脚本的路径 'whatsapp-mcp-server/main.py'。

基本使用方法

  1. 启动 WhatsApp Bridge: 在终端中运行编译后的 'whatsapp-bridge' 程序。 
    whatsapp-bridge/whatsapp-bridge
    程序将输出二维码，使用 WhatsApp 扫描二维码以连接 WhatsApp 账号。'whatsapp-bridge' 还会启动一个 REST API 服务器，默认监听 8080 端口。
  2. 启动 MCP 服务器: 在另一个终端中，运行 'whatsapp-mcp-server/main.py' 脚本启动 MCP 服务器。 
    python whatsapp-mcp-server/main.py
    MCP 服务器默认通过 stdio 与客户端通信。
  3. 配置 MCP 客户端: 在您的 MCP 客户端应用中，根据上述 “服务器配置” 部分的信息配置 WhatsApp MCP 服务器。
  4. 使用 MCP 工具: 配置完成后，您可以使用 MCP 客户端调用 WhatsApp MCP 服务器提供的工具，例如 'search_contacts' (搜索联系人), 'list_messages' (列出消息), 'send_message' (发送消息) 等，与 WhatsApp 进行交互。

注意:

  • 首次运行 'whatsapp-bridge' 需要扫描二维码登录 WhatsApp 账号。
  • 确保 'whatsapp-bridge' 先运行并成功连接 WhatsApp 后，再启动 'whatsapp-mcp-server'。
  • 本服务器依赖于非官方的 WhatsApp API 库 'go-mau.fi/whatsmeow' 和 WhatsApp 网页版协议，使用时请注意 WhatsApp 的服务条款，并承担相应的风险。

信息

分类

通信与社交

访问项目