Okx MCP

🚀 OKX MCP Server

OKXの取引およびポートフォリオ管理機能へのアクセスを提供するモデルコンテキストプロトコル（MCP）サーバーです。このパッケージを使用すると、AIアシスタントがOKXアカウントとやり取りし、ポートフォリオ情報、取引ポジション、注文履歴などを取得できます。

このMCPサーバーは、セキュリティを最優先に設計されています。 以下は、安全に使用できる理由です。

🔒 組み込みのセキュリティ機能

• 読み取り専用アクセス：サーバーは読み取り権限のみを必要とし、取引を行ったり資金を引き出したりすることはできません。
• ローカル処理：すべてのデータはマシン上でローカルに処理され、第三者に保存または送信されることはありません。
• データの永続化なし：取引データはディスクに保存されたり、恒久的にキャッシュされたりすることはありません。
• 直接API通信：仲介サーバーを介さずにOKX APIに直接接続します。

🚀 クイックスタート

ステップ1: OKX API資格情報の作成

1. OKXアカウントにアクセスする：

   • 既存ユーザー：OKX.comにアクセスしてログインします。
   • 新規ユーザー：OKX.comでサインアップし、アカウント認証を完了します。

2. API管理を開く：

   • 直接https://www.okx.com/account/my-apiにアクセスします。

3. APIキーを作成する：

   • 「APIキーを作成」 をクリックします。
   • 説明的な名前（例："MCP Server"）を入力します。
   • 安全な パスフレーズ を作成して保存します（後で必要になります）。

4. 読み取り専用権限を設定する：

   • 読み取り：✅ 有効（ポートフォリオアクセスに必要）
   • 取引：❌ 無効（このMCPサーバーには必要ありません）
   • 引き出し：❌ 無効（このMCPサーバーには必要ありません）

5. 資格情報を生成してコピーする：

   • 「すべて送信」 をクリックしてAPIキーを作成します。
   • 「情報を表示」 をクリックして資格情報を表示します。
   • 「APIキー情報をコピー」 をクリックしてすべての詳細をコピーします。

   資格情報は次のように表示されます。

   apikey = "12345678-abcd-1234-efgh-123456789abc"
   secretkey = "ABCD1234EFGH5678IJKL9012MNOP3456"
   IP = ""
   APIキー名 = "MCP Server"
   権限 = "読み取り"
   

6. 資格情報を安全に保管する：

   • APIキー、シークレットキー、および パスフレーズ を安全な場所に保存します。
   • ⚠️ 重要：シークレットキーは一度しか表示されないため、すぐに保存してください！
   • これらの資格情報は、次のステップでClaude Desktopを設定するために使用されます。

ステップ2: 前提条件のインストール

Claude Desktopを設定する前に、Node.jsをインストールする必要があります。

Node.jsのインストール

オプション1: 公式ウェブサイトからダウンロードする

1. https://nodejs.orgにアクセスします。
2. オペレーティングシステム用の LTS（長期サポート） バージョンをダウンロードします。
3. インストーラーを実行し、セットアップウィザードに従います。

ステップ3: Claude Desktopの設定

1. Claude Desktopの設定を開く：

   • Claude Desktopアプリケーションを起動します。
   • 左下隅の 設定（歯車アイコン）をクリックします。

2. 開発者セクションにアクセスする：

   • 設定パネルの一番下までスクロールします。
   • 「開発者」 セクションをクリックします。

3. 設定を編集する：

   • 「設定を編集」 ボタンをクリックします。
   • これにより、デフォルトのテキストエディターで claude_desktop_config.json ファイルが開きます。

4. OKX MCPサーバーの設定を追加する：

   • ファイルの内容全体を次の設定に置き換えます。

   {
     "mcpServers": {
       "okx-mcp": {
         "command": "okx-mcp",
         "env": {
           "OKX_API_KEY": "your_api_key_here",
           "OKX_API_SECRET": "your_secret_key_here",
           "OKX_API_PASSPHRASE": "your_passphrase_here"
         }
       }
     }
   }
   

5. 資格情報を更新する：

   • your_api_key_here をステップ1の実際の APIキー に置き換えます。
   • your_secret_key_here をステップ1の実際の シークレットキー に置き換えます。
   • your_passphrase_here をステップ1の実際の パスフレーズ に置き換えます。
   • ファイルを保存 してテキストエディターを閉じます。

6. Claude Desktopを再起動する：

   • Claude Desktopを完全に閉じます。
   • アプリケーションを再開して新しい設定を読み込みます。

7. 接続をテストする：

   • Claude Desktopで新しい会話を開始します。
   • 「Show my portfolio」または「Get my account summary」などの質問を試してみます。
   • 成功すれば、ClaudeはOKXアカウントのデータを取得して表示します。

✨ 主な機能

📱 実際の動作を確認する

例：Claudeに「give me account summary」と尋ねると、OKXアカウントのデータからポートフォリオの内訳、資産配分、取引の洞察がすぐに得られます。

AIによるポートフォリオ洞察で取引体験を変革しましょう。 設定後、ClaudeにOKXアカウントに関する自然言語の質問をすることができます。

💰 ポートフォリオ管理

• "What's my current portfolio balance?"
• "Show me my asset allocation"
• "Which coins do I own and how much are they worth?"
• "What's my biggest position by value?"

📊 取引分析

• "Show me my open positions with P&L"
• "What orders do I have pending?"
• "Analyze my BTC trading history from last month"
• "How did my ETH trades perform this week?"

🎯 スマート洞察

• "What's my total unrealized profit/loss?"
• "Which assets have gained the most value?"
• "Give me a summary of my trading activity"
• "How is my portfolio performing today?"

🔍 詳細レポート

• "Create a detailed report of my portfolio"
• "Show me all my completed trades for BTC-USDT"
• "What's my trading volume for this month?"
• "Break down my portfolio by percentage"

AIは即座に分析を行い、洞察を生成し、簡単な会話を通じて情報に基づいた取引決定を支援します。

📦 インストール

ローカル開発

# リポジトリをクローンする
git clone https://github.com/maxbarinov/okx-mcp.git
cd okx-mcp

# 依存関係をインストールする
npm install

# 環境変数を設定する
cp .env.example .env
# .envをOKX API資格情報で編集する

# 開発モードで実行する
npm run dev

ビルド

npm run build

プロジェクト構造

src/
├── services/
│   └── okxApiClient.ts    # OKX APIクライアントラッパー
└── tools/                # MCPツールの実装
    ├── get_account_summary.ts
    ├── get_portfolio.ts
    ├── get_positions.ts
    ├── get_open_orders.ts
    └── get_order_history.ts

💻 使用例

このMCPサーバーは、AIアシスタントに次のツールを提供します。

1. アカウント概要の取得

• ツール：get_account_summary
• 説明：総額や資産配分を含む集計されたポートフォリオ指標を取得します。
• パラメーター：なし

2. ポートフォリオの取得

• ツール：get_portfolio
• 説明：アカウント内のすべての資産に関する詳細情報を取得します。
• パラメーター：なし
• 戻り値：残高、利用可能額、およびUSDT価値を含む通貨のリスト

3. ポジションの取得

• ツール：get_positions
• 説明：すべての未決済のデリバティブ取引ポジションを取得します。
• パラメーター：なし
• 戻り値：サイズ、エントリー価格、および未実現損益を含むポジションの詳細

4. 未決済注文の取得

• ツール：get_open_orders
• 説明：現在のすべての未決済取引注文を取得します。
• パラメーター：なし
• 戻り値：シンボル、タイプ、価格、およびステータスを含む注文の詳細

5. 注文履歴の取得

• ツール：get_order_history
• 説明：分析用の過去の約定注文を取得します。
• パラメーター：
  • instId（必須）：取引対象のID（例："BTC-USDT"）
  • begin（オプション）：開始タイムスタンプ
  • end（オプション）：終了タイムスタンプ
• 戻り値：約定詳細を含む過去の注文データ

📚 ドキュメント

開発に関する情報

ローカル開発

# リポジトリをクローンする
git clone https://github.com/maxbarinov/okx-mcp.git
cd okx-mcp

# 依存関係をインストールする
npm install

# 環境変数を設定する
cp .env.example .env
# .envをOKX API資格情報で編集する

# 開発モードで実行する
npm run dev

ビルド

npm run build

プロジェクト構造

src/
├── services/
│   └── okxApiClient.ts    # OKX APIクライアントラッパー
└── tools/                # MCPツールの実装
    ├── get_account_summary.ts
    ├── get_portfolio.ts
    ├── get_positions.ts
    ├── get_open_orders.ts
    └── get_order_history.ts

貢献方法

1. リポジトリをフォークする
2. 機能ブランチを作成する
3. 変更を加える
4. 適用可能な場合はテストを追加する
5. プルリクエストを送信する

📄 ライセンス

MIT

サポート

問題が発生した場合や質問がある場合は、以下の手順に従ってください。

1. GitHub Issuesを確認する
2. 問題の詳細情報を含む新しいissueを作成する
3. 環境の詳細とエラーメッセージ（機密データを除く）を含める

関連プロジェクト

• Model Context Protocol
• xmcp Framework
• OKX API Documentation