Ycloud Whatsapp MCP Server

🚀 YCloud WhatsApp API MCP 服务器

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

🚀 快速开始

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

1. 在 YCloud 官网 注册一个账户。
2. 获取您的 API 密钥（请参阅下面的说明）。
3. 安装必要的软件依赖（请参阅下面的说明）。

系统要求如下：

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

✨ 主要特性

• 自动从 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_desktop_config.json。
   • 在 Windows 上：%APPDATA%\Claude\claude_desktop_config.json。
2. 添加以下配置：

{
  "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"
      }
    }
  }
}

3. 替换 your-api-key-here 为您的 YCloud API 密钥。

直接运行

# 设置环境变量并运行
API_BASE_URL=https://api.ycloud.com/v2 \
API_HEADERS="X-API-Key: your_api_key_here" \
node index.js

高级用法

在 Claude 中使用以下提示语：

/YCloud API Balance 查询我的账户余额。

📚 详细文档

调试

• 使用 console.log() 进行调试。
• 使用 process.env 查看环境变量。
• 使用 express 中间件调试 API 请求和响应。

贡献

欢迎贡献！请参考 贡献指南。

📄 许可证

此项目使用 MIT License。