0xAuto OKX MCP Server

0xAuto OKX MCP Server

このサーバーはModel Context Protocol（MCP）に基づいており、OKX V5 APIおよびOKX DEX API向けのツールインターフェース層を提供します。 AI エージェントがOKXの取引所（CEX）および分散型取引所（DEX）の機能を簡単に利用できるようにします。

機能

CEX（中央集権型取引所）の機能

• 複雑なOKX APIの認証および署名ロジックを隠蔽します
• 標準的なMCPツールインターフェースを提供します
• 次の主要機能を網羅しています：
  • アカウント情報（残高、ポジション、履歴）
  • 市場データ（相場、ローソク足）
  • 取引操作（注文の発注、注文のキャンセル、注文管理）
  • 資金操作（入金アドレス、出金）

DEX（分散型取引所）の機能

• OKX DEXアグリゲーターを利用できます

• マルチチェーン取引およびトークン交換に対応しています

• 次の機能を網羅しています：

  • トークン相場の取得
  • トークン価格の照会とローソク足データ
  • オンチェーン残高の照会
  • トークンの承認操作
  • チェーン内およびクロスチェーンのスワップ

• JSONレスポンスとエラー処理を標準化しています

• MCPプロトコルのセッション管理とストリーミングに対応しています

システム要件

• Node.js（v16以上）
• pnpm

インストール手順

1. 依存関係をインストールします：

   pnpm install
   

2. 環境変数を設定します： .env.exampleの内容をコピーして.envファイルを作成します：

   cp .env.example .env
   

   .envファイルを編集し、OKX API認証情報などの設定を入力します：

   # OKX API Configuration
   OKX_API_KEY=your_okx_api_key
   OKX_SECRET_KEY=your_okx_secret_key
   OKX_PASSPHRASE=your_okx_api_password
   OKX_API_BASE_URL=https://www.okx.com
   OKX_DEX_API_BASE=https://web3.okx.com/api/v5/dex
   
   # Simulated trading: 0 for live trading, 1 for demo account
   SIMULATED_TRADING=0
   
   SERVER_PORT=3000
   LOG_LEVEL=info
   

   重要： OKX API Keyに必要な権限（読み取り、取引）が付与されていることを確認してください。

サーバーの起動

pnpm start
# or development mode
pnpm dev

サーバーはSERVER_PORTで指定されたポート（デフォルトは3000）で起動します。

MCP ツール一覧

サーバーは次のMCPツールを実装しています：

CEX（中央集権型取引所）ツール

アカウント関連ツール

• okx_get_account_info - アカウント情報を取得します
• okx_get_positions - ポジション情報を取得します
• okx_get_balance - アカウント残高を取得します

取引関連ツール

• okx_place_order - 取引注文を発注します
• okx_cancel_order - 注文をキャンセルします
• okx_get_orders - 注文情報を取得します
• okx_get_order_history - 注文履歴を取得します

市場データツール

• okx_get_ticker - 市場相場を取得します
• okx_get_kline - ローソク足データを取得します
• okx_get_instruments - 商品一覧を取得します

資金関連ツール

• okx_get_deposit_address - 入金アドレスを取得します
• okx_get_deposit_history - 入金記録を取得します
• okx_withdraw - 資金を出金します

DEX（分散型取引所）ツール

相場と市場データ

• okx_get_quote - OKX DEXアグリゲーターの相場を取得します（スリッページ設定に対応）
• okx_get_supported_chains - OKX DEXがサポートするチェーンを取得します
• okx_get_token_list - OKX DEXがサポートするトークン一覧を取得します
• okx_get_price - OKX DEX上のトークンの最新価格を取得します
• okx_get_kline - OKX DEX上のトークンのローソク足データを取得します（時間粒度の指定に対応）

取引関連ツール

• okx_approve_transaction - OKX DEXの承認トランザクション情報を取得します
• okx_swap - OKX DEXのスワップを開始します
• okx_cross_chain_swap - OKX DEXのクロスチェーンスワップを開始します

残高の照会

• okx_get_balance - 指定したチェーン上にあるウォレットアドレスのすべてのトークン残高を取得します

プロジェクト構成

src/
├── app.js              # Express application configuration
├── index.js            # Server startup entry
├── server.js           # MCP server creation and tool registration
├── config/             # Configuration files
├── controllers/        # Controller logic
├── middleware/         # Middleware
├── services/           # Service layer
│   ├── okxService.js   # OKX CEX API service
│   └── okxDexService.js# OKX DEX API service
├── tools/              # MCP tool implementation
│   ├── accountTools.js # CEX account tools
│   ├── fundingTools.js # CEX funding tools
│   ├── marketTools.js  # CEX market tools
│   ├── tradeTools.js   # CEX trading tools
│   ├── dexTools.js     # DEX tool registration
│   └── dex/            # DEX tool files
│       ├── quoteTool.js         # Quote tool
│       ├── supportedChainsTool.js# Supported chains tool
│       ├── tokenListTool.js     # Token list tool
│       ├── priceTool.js         # Price tool
│       ├── klineTool.js         # K-line tool
│       ├── balanceTool.js       # Balance tool
│       ├── approveTool.js       # Approval tool
│       ├── swapTool.js          # Swap tool
│       └── crossChainSwapTool.js# Cross-chain swap tool
└── utils/              # Utility functions

MCP クライアント接続

MCPクライアントは、次のエンドポイントを通じてサーバーと通信できます：

• /mcp - MCPのメインリクエストエンドポイント
• /sse - 下位互換性のあるSSEエンドポイント
• /messages - 下位互換性のあるメッセージエンドポイント

セッションIDや初期化リクエストを含む、標準的なMCPセッション管理を使用します。