OKX MCP Server

OKX MCP 服务

本项目创建了一个模型上下文协议（MCP）服务，用于从 OKX 交易所获取实时加密货币数据。它允许 Claude 等 AI 助手通过定义的工具获取最新的加密货币价格信息和历史数据，并提供增强的可视化功能和 WebSocket 实时更新。

功能

• get_price：获取加密货币交易对的最新价格数据，并进行可视化格式处理
• get_candlesticks：获取历史 K 线数据，并提供包括 ASCII 图表在内的可视化选项
• subscribe_ticker：订阅交易对的实时 WebSocket 更新
• get_live_ticker：获取 WebSocket 连接中的最新实时数据
• unsubscribe_ticker：停止接收指定交易对的更新

先决条件

• Node.js（推荐 v16 或更高版本）
• npm 或 yarn
• 安装了 Claude 扩展的 VSCode（如果使用 VSCode 集成）
• Claude Desktop（如果不使用 VSCode）

安装

1. 克隆仓库

   git clone https://github.com/yourusername/okx-mcp-server.git
   cd okx-mcp-server
   

2. 安装依赖项

   npm install
   

3. 添加 WebSocket 依赖项

   npm install ws
   npm install --save-dev @types/ws
   

4. 构建项目

   npm run build
   

5. 将编译后的脚本设为可执行文件

   chmod +x build/index.js
   

用法

直接运行服务

你可以通过以下命令直接运行服务：

npm start

或者：

node build/index.js

使用 MCP Inspector 测试

在集成前测试你的 MCP 服务：

npx @modelcontextprotocol/inspector node build/index.js

在检查器中，你可以测试：

• 使用输入 { "instrument": "BTC-USDT", "format": "markdown" } 测试 get_price
• 使用输入 { "instrument": "BTC-USDT", "bar": "1m", "limit": 10, "format": "markdown" } 测试 get_candlesticks
• 使用输入 { "instrument": "BTC-USDT" } 测试 subscribe_ticker
• 使用输入 { "instrument": "BTC-USDT", "format": "markdown" } 测试 get_live_ticker
• 使用输入 { "instrument": "BTC-USDT" } 测试 unsubscribe_ticker

每个工具都支持不同的可视化格式：

• format：选择 markdown、json 或 table（用于 K 线数据）

与 VSCode 集成

1. 安装适用于 VSCode 的 Claude 扩展

2. 在 VSCode 设置中配置 MCP 服务：

   • 创建或编辑以下文件：

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

   • 添加以下配置：

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

   • 将 /absolute/path/to/okx-mcp-server/build/index.js 替换为你的实际文件路径

3. 重启 VSCode 或重新加载 Claude 扩展

与 Claude Desktop 集成

如果使用 Claude Desktop，请查阅其文档，了解 MCP 配置设置的适当存放位置。

示例提示词

集成完成后，你可以向 Claude 提问：

1. “Bitcoin（BTC-USDT）的当前价格是多少？请以美观的格式显示。”
2. “使用 5 分钟间隔，以可视化形式展示过去一小时内 Ethereum（ETH-USDT）的价格趋势。”
3. “比较 BTC-USDT 和 ETH-USDT 的当前价格。”
4. “分析 SOL-USDT 最近 20 根 1 分钟 K 线，并以表格形式展示。”
5. “BTC-USDT 的当前价格高于还是低于其 24 小时最高价？请可视化价格区间。”
6. “订阅 Bitcoin 价格的实时更新，并在价格变化时告诉我。”
7. “显示 Ethereum 的最新实时数据。”
8. “实时监控 BTC-USDT，如果价格向任一方向波动超过 1%，则提醒我。”

数据可视化功能

增强版 MCP 服务提供丰富的数据可视化：

价格数据可视化

• 格式化的 Markdown 输出，清晰展示价格信息
• 可视化价格区间条，显示当前价格在 24 小时最高价与最低价之间的位置
• 价格变化方向指示符（▲/▼）
• 格式化数字，提升可读性

蜡烛图数据可视化

• Markdown 格式：包含摘要统计、价格走势 ASCII 图表，以及近期价格走势表格
• 表格格式：以简洁表格展示蜡烛图数据
• JSON 格式：供程序使用的原始数据

格式选项

• get_price：支持 markdown（默认）或 json 格式
• get_candlesticks：支持 markdown（默认）、table 或 json 格式
• get_live_ticker：支持 markdown（默认）或 json 格式

WebSocket 实时更新

此服务支持 WebSocket，可接收来自 OKX 的实时数据：

WebSocket 的工作方式

• 与 OKX 的 WebSocket API 建立持久连接
• 每当价格发生变化时接收推送更新
• 为每个已订阅的交易品种缓存最新数据
• 连接断开时自动重新连接

WebSocket 工具

• subscribe_ticker：开始订阅实时行情更新
• get_live_ticker：获取活跃订阅中的最新数据
• unsubscribe_ticker：不再需要监控时结束订阅

实时更新的使用场景

• 实时监控价格走势
• 设置价格提醒
• 实时追踪市场波动
• 根据最新数据做出明智的交易决策

环境变量（可选）

此基础实现使用 OKX 的公共 API 端点，无需身份验证。如果你扩展服务以使用需要身份验证的端点，可以考虑添加以下环境变量：

OKX_API_KEY=your_api_key
OKX_API_SECRET=your_api_secret
OKX_API_PASSPHRASE=your_api_passphrase

安全说明

• 当前实现仅使用 OKX 的公共 API 端点，因此无需 API 密钥
• 代码库中不存储任何敏感数据
• 可以放心地直接将此代码提交到 Git

扩展服务

你可以通过以下方式扩展此 MCP 服务：

1. 为其他 OKX API 端点添加更多工具
2. 使用 API 密钥实现需要身份验证的端点
3. 添加对其他交易所的支持
4. 通过更复杂的图表进一步增强可视化效果
5. 添加技术分析指标（RSI、MACD、移动平均线）
6. 为多种加密货币实现价格对比工具
7. 添加市场摘要功能，以便进行更广泛的市场分析

许可证

MIT