JinDaGe - okx-mcp MCP Details

article

README

🚀 OKX MCP 服务器

OKX MCP 服务器是一个基于 Model Context Protocol（MCP）的服务器，它能够从 OKX 交易所获取数据，并为用户提供实时的加密货币价格信息。该服务器通过简单易用的工具界面，让用户能够方便地获取所需的市场数据。

✨ 主要特性

连接到 OKX API，为用户提供全面的加密货币价格信息。
具备完善的错误处理机制，能捕获网络错误并带上下文返回，对无效的器械 ID 也会返回错误。
实现了请求日志记录，方便后续的查询和分析。
通过 OKX API 进行速率限制，确保服务的稳定性和可靠性。

📦 安装指南

开发环境依赖安装

npm install

服务器构建

npm run build

带自动重建的开发模式

npm run watch

与 Claude Desktop 或 VSCode 集成安装

将服务器配置添加到 MCP 设置中：

macOS (VSCode)

~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

macOS (Claude Desktop)

~/Library/Application Support/Claude/claude_desktop_config.json

Windows (VSCode)

%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

Windows (Claude Desktop)

%APPDATA%/Claude/claude_desktop_config.json

配置文件示例

{
  "mcpServers": {
    "okx": {
      "command": "node",
      "args": ["/path/to/okx-mcp-server/build/index.js"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

💻 使用示例

工具介绍

`get_candlesticks`

用于检索任何 OKX 器械的历史蜡烛图（OHLCV）数据。

输入参数：
- instrument（必填）：器械 ID，例如 "BTC-USDT"。
- bar（可选）：时间间隔，例如 "1m", "5m", "1H", "1D"，默认为 "1m"。
- limit（可选）：返回的蜡烛图数量，最大值为 100，默认 100。
输出结果：包含以下字段的 JSON 对象数组：
- timestamp：烛台的 ISO 时间戳。
- open：开盘价。
- high：最高价。
- low：最低价。
- close：收盘价。
- volume：交易量。
- volumeCurrency：以货币表示的交易量。

示例用法：

[
  {
    "timestamp": "2025-03-07T17:00:00.000Z",
    "open": "87242.8",
    "high": "87580.2",
    "low": "86548.0",
    "close": "87191.8",
    "volume": "455.72150427",
    "volumeCurrency": "39661166.242091111"
  }
]

`get_price`

用于获取任何 OKX 器械的最新价格和 24 小时市场数据。

输入参数：
- instrument（必填）：器械 ID，例如 "BTC-USDT"。
输出结果：包含以下字段的 JSON 对象：
- instrument：请求的器械 ID。
- lastPrice：最新交易价格。
- bid：当前最佳买入价。
- ask：当前最佳卖出价。
- high24h：24 小时最高价。
- low24h：24 小时最低价。
- volume24h：24 小时交易量。
- timestamp：数据的 ISO 时间戳。

示例用法：

{
  "instrument": "BTC-USDT",
  "lastPrice": "65432.1",
  "bid": "65432.0",
  "ask": "65432.2",
  "high24h": "66000.0",
  "low24h": "64000.0",
  "volume24h": "1234.56",
  "timestamp": "2024-03-07T17:22:28.000Z"
}

🔧 技术细节

错误处理

服务器实现了全面的错误处理机制：

捕获网络错误并带上下文返回，方便用户定位和解决问题。
对于无效的器械 ID，会返回相应的错误信息。
默认情况下，所有响应都会带有 code 和 message 字段，便于用户理解错误详情。

okx-mcp