JinDaGe - mcp-whatsapp-server MCP Details

article

README

🚀 基于 MCP 协议的 WhatsApp 服务器

本项目是一个基于 Model Context Protocol (MCP) 的服务器，借助 API Waha 实现与 WhatsApp 的集成。它让兼容 MCP 的 AI 助手（如 Claude）能直接与 WhatsApp 上的联系人进行交互。

🚀 快速开始

本服务器允许兼容 MCP 的 AI 助手（如 Claude）直接与 WhatsApp 上的联系人交互。项目使用 Waha API 作为后端，实现与 WhatsApp Web 的通信。

✨ 主要特性

✅ 验证 WhatsApp 连接状态
✅ 通过手机号发送消息
✅ 通过已注册的联系人姓名发送消息
✅ 管理联系人（按名称）
✅ 查看服务器配置

📦 安装指南

克隆仓库

git clone https://github.com/seu-usuario/mcp-whatsapp-server.git
cd mcp-whatsapp-server

安装依赖项

pip install -r requirements.txt

配置环境变量

在 .env 文件中进行如下配置：

WAHA_API_URL=http://localhost:3000
WAHA_SESSION_ID=default
CONTATOS_FILE=caminho/para/contatos.json (opcional)

配置联系人

在 contatos.json 文件中配置联系人信息：

{
    "contatos": {
        "Nome1": "5511999999999",
        "Nome2": "5522888888888"
    }
}

💻 使用示例

基础用法

启动 Waha API

按照官方说明启动 Waha API。

运行 MCP 服务器

python server.py

与服务器交互

使用兼容的 MCP 客户端（如 Claude Desktop）与服务器交互。

高级用法

验证连接状态

status = verificar_conexao_whatsapp()
print(f"Status: {status['mensagem']}")

通过手机号发送消息

resultado = enviar_mensagem_whatsapp("5511999999999", "Olá! Esta é uma mensagem de teste.")
print(f"Resultado: {resultado['mensagem']}")

通过姓名发送消息

resultado = enviar_mensagem_por_nome("Pedro", "Olá! Esta é uma mensagem de teste.")
print(f"Resultado: {resultado['mensagem']}")

📚 详细文档

可用的 MCP 资源

资源

waha://configuracao - Waha API 配置
waha://status - WhatsApp 当前连接状态
waha://contatos - 按名称映射的联系人列表

工具（Tools）

verificar_conexao_whatsapp() - 验证当前 WhatsApp 连接状态
enviar_mensagem_whatsapp(numero, mensagem) - 通过手机号发送消息

📄 许可证

该项目根据 MIT License 发布。

贡献

欢迎贡献！随时欢迎提出问题或提交拉取请求。

mcp-whatsapp-server