YCloud-Developers_ycloud-whatsapp-mcp-server

🚀 YCloud WhatsApp API MCP 服务器

这是一个基于 模型上下文协议（MCP） 构建的 YCloud WhatsApp API 服务器。它能自动从 YCloud WhatsApp OpenAPI 规范生成工具，让 AI 模型（如 Claude）可直接与 YCloud WhatsApp API 交互，极大提升了交互效率和便捷性。

🚀 快速开始

在使用此服务器前，您需完成以下准备工作：

1. 在 YCloud 官网 注册账户。
2. 获取 API 密钥（具体方法见后续说明）。
3. 安装必要的软件依赖（具体步骤见后续说明）。

✨ 主要特性

• 自动从 OpenAPI 规范生成 MCP 工具，提高开发效率。
• 支持所有 YCloud API 端点，功能全面。
• 支持 API 认证，保障数据安全。
• 自动处理参数类型和验证，减少人工错误。
• 支持 HTTP 请求和响应处理，方便数据交互。

📦 安装指南

# 克隆仓库
git clone https://github.com/YCloud-Developers/ycloud-whatsapp-mcp-server.git
cd ycloud-whatsapp-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

💻 使用示例

基础用法

获取 API 密钥

要使用 YCloud API，需用 API 密钥进行身份验证：

1. 登录到 YCloud 控制台。
2. 导航到开发者页面。
3. 在此页面可找到 API 密钥。

API 密钥应作为请求头 X-API-Key 包含在所有 API 请求中。

环境变量配置

可通过以下环境变量配置服务器：

• API_BASE_URL：YCloud API 的基础 URL（默认：https://api.ycloud.com/v2）
• OPENAPI_SPEC_PATH：OpenAPI 规范的路径或 URL（默认：https://docs.ycloud.com/openapi.json）
• API_HEADERS：API 请求头（格式：key1:value1,key2:value2）

Claude 桌面端集成

要在 Claude 桌面应用中使用此服务器，请编辑 Claude 配置文件：

1. 找到或创建 Claude 桌面配置文件：
   • 在 macOS 上：~/Library/Application Support/Claude/claude.json
   • 在 Windows 上：%APPDATA%/Claude/claude.json
2. 在配置文件中添加以下内容：

{
  "ycloud-mcp-server": {
    "enabled": true,
    "apiKey": "your-api-key",
    "baseUrl": "https://api.ycloud.com/v2"
  }
}

直接运行

1. 确保已获取 API 密钥并安装了服务器。
2. 在终端或命令提示符中，导航到项目目录：

cd ycloud-whatsapp-mcp-server

3. 运行服务器：

npm start

高级用法

要在 Claude 中使用此服务器查询账户余额，请输入以下提示： "请告诉我我的 YCloud 账户余额。"

🔧 技术细节

系统要求

• Node.js v16.0.0 或更高版本
• npm v7.0.0 或更高版本
• Claude 桌面应用（如果要与 Claude 集成）

调试

1. 查看日志：在终端或命令提示符中，运行：

npm run debug

2. 使用 MCP Inspector 工具检查请求和响应。

🤝 贡献

欢迎为该项目做出贡献！请提交拉取请求或报告问题到 GitHub 仓库 YCloud-Developers/ycloud-whatsapp-mcp-server。

📄 许可证

此项目遵循 MIT 许可证。