返回 MCP 目录
public公开dns本地运行

mcp-evolution-whatsapp-api

一个连接Claude与WhatsApp的MCP服务器,通过Evolution API实现自动化交互功能

article

README

🚀 MCP Evolution API 服务器

这是一个专门为Claude设计的Model Context Protocol (MCP)服务器,它集成了Evolution API,主要用于WhatsApp自动化操作。通过该服务器,Claude能够借助Evolution API与WhatsApp进行交互,从而实现一系列功能,为WhatsApp的管理和使用带来便利。

🚀 快速开始

该MCP服务器允许Claude通过Evolution API与WhatsApp进行交互,实现以下功能:

  • 管理WhatsApp实例
  • 发送各种类型的消息
  • 处理联系人和群组
  • 配置网钩和设置

📦 安装指南

环境配置

首先,你需要创建一个.env文件,在其中包含你的Evolution API凭证,示例如下:

EVOLUTION_API_URL=https://your-evolution-api-server.com
EVOLUTION_API_KEY=your-api-key-here

📋 部署选项

| 环境 | 步骤 | 命令 | |------|-------|---------| | 本地开发 | 1. 克隆并安装
2. 在开发模式下运行 | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun install
bun run dev | | 本地生产 | 1. 克隆并安装
2. 构建并运行 | git clone https://github.com/aiteks-ltda/mcp-evo-api.git && cd mcp-evo-api && bun install
bun run build && bun run dist/main.js | | Docker | 1. 克隆项目
2. 构建镜像:docker-compose up --build
3. 运行:docker-compose up | docker-compose up --build |

Claude Desktop 配置

若要在Claude Desktop中使用此服务器,你需要导航至Settings > Extensions > Add Extension,然后粘贴以下内容:

{
  "title": "MCP Evolution API",
  "author": "Your Name",
  "version": "1.0",
  "description": "Evolution API的MCP扩展",
  "main": "dist/main.js"
}

📂 项目结构

mcp-evo-api/
├── src/
│   ├── tools/          # Evolution API的MCP工具实现
│   ├── utils/          # 公共实用程序,包括Evolution API客户端
│   ├── main.ts         # 服务器入口点
│   └── types.ts        # 共用类型定义
├── scripts/            # 辅助脚本
├── biome.json          # 代码检查配置
├── tsconfig.json       # TypeScript配置
├── docker-compose.yml  # Docker Compose配置
├── Dockerfile          # Docker构建配置
└── package.json        # 项目依赖

📚 详细文档

实现状态

| 功能模块 | 已实现功能 | 待实现功能 | |----------|------------|------------| | WhatsApp实例 | 管理实例 | 无 | | 消息发送 | 发送文本、图片、视频等 | 支持更多媒体类型 | | 联系人处理 | 添加、删除联系人 | 导入导出联系人 | | 群组管理 | 创建、解散群组 | 群组成员管理 | | 网钩配置 | 设置和禁用网钩 | 复杂网钩逻辑 |

更多信息

请参考Evolution API文档获取更多技术细节和使用指南。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端