Ycloud Developers Ycloud Whatsapp MCP Server

🚀 YCloud WhatsApp API MCPサーバー

English | 中文

これは、モデルコンテキストプロトコル（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.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ツールを使用して、リクエストとレスポンスを確認します。

📚 ドキュメント

前提条件

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

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

システム要件

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

📄 ライセンス

このプロジェクトはMITライセンスに基づいています。

貢献

このプロジェクトへの貢献を歓迎します！GitHubリポジトリ YCloud-Developers/ycloud-whatsapp-mcp-server にプルリクエストを送信するか、問題を報告してください。