Okx MCP

🚀 OKX MCP 服務器

OKX MCP 服務器是一個模型上下文協議（MCP）服務器，它提供對 OKX 交易和投資組合管理功能的訪問。此軟件包允許 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 服務器”）。
   • 創建並保存一個安全的 密碼短語（稍後會用到）。
4. 設置只讀權限：
   • 讀取：✅ 啟用（訪問投資組合必需）
   • 交易：❌ 禁用（此 MCP 服務器不需要）
   • 提現：❌ 禁用（此 MCP 服務器不需要）
5. 生成並複製憑證：
   • 點擊 “全部提交” 創建 API 密鑰。
   • 點擊 “顯示信息” 顯示憑證。
   • 點擊 “複製 API 密鑰信息” 複製所有詳細信息。 你的憑證將如下所示：

   apikey = "12345678-abcd-1234-efgh-123456789abc"
   secretkey = "ABCD1234EFGH5678IJKL9012MNOP3456"
   IP = ""
   API 密鑰名稱 = "MCP 服務器"
   權限 = "讀取"
   

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 中開始新對話。
   • 嘗試詢問：“顯示我的投資組合” 或 “獲取我的賬戶摘要”。
   • 如果成功，Claude 將檢索並顯示你的 OKX 賬戶數據。

✨ 主要特性

📱 實際效果展示

示例：向 Claude 詢問“給出我的賬戶摘要”，即可立即獲取你的投資組合明細、資產分配和交易洞察——所有數據均來自你的 OKX 賬戶。

藉助 AI 驅動的投資組合洞察，改變你的交易體驗。配置完成後，你可以用自然語言向 Claude 詢問有關 OKX 賬戶的問題：

💰 投資組合管理

• “我當前的投資組合餘額是多少？”
• “展示我的資產分配情況”
• “我持有哪些加密貨幣，它們的價值是多少？”
• “按價值計算，我最大的持倉是什麼？”

📊 交易分析

• “展示我的持倉及盈虧情況”
• “我有哪些待處理的訂單？”
• “分析我上個月的比特幣交易歷史”
• “我本週的以太坊交易表現如何？”

🎯 智能洞察

• “我的總未實現盈虧是多少？”
• “哪些資產增值最多？”
• “給出我的交易活動摘要”
• “我今天的投資組合表現如何？”

🔍 詳細報告

• “生成我的投資組合詳細報告”
• “展示我所有已完成的比特幣 - 美元交易”
• “我本月的交易成交量是多少？”
• “按百分比分解我的投資組合”

AI 可以通過簡單的對話提供即時分析、生成洞察並幫助你做出明智的交易決策。

📦 安裝指南

本地開發

# 克隆倉庫
git clone https://github.com/maxbarinov/okx-mcp.git
cd okx-mcp

# 安裝依賴
npm install

# 設置環境變量
cp .env.example .env
# 用你的 OKX API 憑證編輯 .env

# 在開發模式下運行
npm run dev

構建

npm run build

💻 使用示例

可用工具

此 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（可選）：結束時間戳
• 返回：包含執行細節的歷史訂單數據。

🔧 技術細節

項目結構

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 問題。
2. 創建一個新問題，並詳細描述你的問題。
3. 提供你的環境詳細信息和錯誤消息（不包含敏感數據）。

🔗 相關項目

• 模型上下文協議
• xmcp 框架
• OKX API 文檔