Ycloud Developers Ycloud Whatsapp MCP Server

🚀 YCloud WhatsApp API MCP 服務器

這是一個基於 模型上下文協議（MCP） 構建的 YCloud WhatsApp API 服務器。它能自動從 YCloud WhatsApp OpenAPI 規範生成工具，讓 AI 模型（如 Claude）可直接與 YCloud WhatsApp API 交互，極大提升了 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 賬戶餘額。"

📚 詳細文檔

調試

1. 查看日誌：在終端或命令提示符中，運行：

npm run debug

2. 使用 MCP Inspector 工具檢查請求和響應。

貢獻

歡迎為該項目做出貢獻！請提交拉取請求或報告問題到 GitHub 倉庫 YCloud-Developers/ycloud-whatsapp-mcp-server。

📄 許可證

此項目遵循 MIT 許可證。