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。