项目简介

本仓库 'ycloud-whatsapp-mcp-server' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在简化大型语言模型（LLM）与 YCloud WhatsApp API 的集成。它能够自动从 YCloud WhatsApp OpenAPI 规范中生成工具，使得 LLM 客户端（如 Claude）能够直接调用 YCloud WhatsApp API 的各项功能，例如发送消息、管理联系人、查询账户信息等。

主要功能点

自动化工具生成: 自动从 YCloud WhatsApp OpenAPI 规范生成 MCP 工具，无需手动编写工具定义。
全面API覆盖: 支持 YCloud WhatsApp API 的所有端点，功能全面。
API 认证支持: 支持 YCloud API 的身份验证机制，保证API调用的安全性。
参数处理与校验: 自动处理 API 参数类型和验证，简化工具调用。
HTTP 请求处理: 支持 HTTP 请求和响应处理，实现与 YCloud API 的无缝对接。
易于集成 Claude: 提供详细的 Claude 桌面应用集成配置指南。

安装步骤

克隆仓库:

git clone https://github.com/YCloud-Developers/ycloud-whatsapp-mcp-server.git
cd ycloud-whatsapp-mcp-server

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

要将此 MCP 服务器与 MCP 客户端（例如 Claude 桌面应用）集成，您需要配置客户端以连接到此服务器。以下是 Claude 桌面应用的 'claude_desktop_config.json' 配置文件示例，展示了如何配置 'ycloud-whatsapp-mcp-server'：

{
  "mcpServers": {
    "ycloud-whatsapp": {
      "command": "node",
      "args": ["path/to/ycloud-whatsapp-mcp-server/build/index.js"],
      "env": {
        "API_BASE_URL": "https://api.ycloud.com/v2",
        "API_HEADERS": "X-API-Key:your-api-key-here"
      }
    }
  }
}

配置参数说明:

'"ycloud-whatsapp"': 服务器名称，在 Claude 客户端中用于标识和调用此服务器，可以自定义。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行时环境。
'"args": ["path/to/ycloud-whatsapp-mcp-server/build/index.js"]': 启动命令的参数，指向编译后的服务器入口文件 'index.js' 的路径。 请将 'path/to/ycloud-whatsapp-mcp-server' 替换为您的本地仓库路径。
'"env"': 环境变量配置，用于传递服务器运行所需的配置信息。
- '"API_BASE_URL": "https://api.ycloud.com/v2"': YCloud API 的基础 URL，默认为官方 API 地址。
- '"API_HEADERS": "X-API-Key:your-api-key-here"': API 请求头信息，用于 API 身份验证。 请将 'your-api-key-here' 替换为您在 YCloud 控制台获取的 API 密钥。

获取 YCloud API 密钥:

登录 YCloud 控制台。
导航至开发者页面或 API 密钥管理页面。
在该页面找到并复制您的 API 密钥。

基本使用方法

启动服务器: 根据您的配置方式启动 MCP 服务器。如果选择直接运行，可以使用以下命令（请替换 'your-api-key-here' 为您的实际 API 密钥）：

API_BASE_URL=https://api.ycloud.com/v2 \
API_HEADERS="X-API-Key:your-api-key-here" \
npm start

在 MCP 客户端中使用: 在配置好 MCP 服务器的客户端（如 Claude）中，您可以使用自然语言指令来调用 YCloud WhatsApp API 的功能。例如，在 Claude 中，您可以输入：

请帮我查询我的YCloud账户余额。

或者

发送一条 WhatsApp 消息给 +86138xxxxxxxx，内容是“你好！”

客户端会识别指令，并调用相应的 MCP 工具与 YCloud WhatsApp API 交互，最终返回结果。

注意: 请确保您已正确配置 API 密钥，并且 YCloud 账户拥有相应的 API 访问权限。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息