Ycloud Whatsapp MCP Server

🚀 YCloud WhatsApp API MCP サーバー

このサーバーは、Model Context Protocol (MCP)に基づいて構築されたYCloud WhatsApp APIサーバーです。YCloud WhatsApp OpenAPI仕様から自動的にツールを生成し、AIモデル（Claudeなど）がYCloud WhatsApp APIと直接やり取りできるようにします。

🚀 クイックスタート

このサーバーを使用する前に、いくつかの前提条件を満たす必要があります。また、システム要件を確認し、サーバーのインストールと使用方法を学ぶことができます。

✨ 主な機能

• 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キーは、すべてのAPIリクエストのリクエストヘッダー X-API-Key に含める必要があります。

環境変数の設定

以下の環境変数を使用してサーバーを設定できます。

• 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 自分のアカウント残高を照会する。

🔧 技術詳細

前提条件

このサーバーを使用する前に、以下のことが必要です。

1. YCloud公式ウェブサイトでアカウントを登録します。
2. APIキーを取得します（下記の説明を参照）。
3. 必要なソフトウェア依存関係をインストールします（下記の説明を参照）。

システム要件

• Node.js v16.0.0 以上
• npm v7.0.0 以上
• Claudeデスクトップアプリ（Claudeと統合する場合）

デバッグ

• console.log() を使用してデバッグします。
• process.env を使用して環境変数を確認します。
• express ミドルウェアを使用してAPIリクエストとレスポンスをデバッグします。

📄 ライセンス

このプロジェクトはMIT Licenseの下でライセンスされています。

🔗 その他のリンク

• 貢献ガイド
• English