OKX MCP Server

OKX MCP Server

site icon
2025.03.16 1
JavaScript加密货币数据服务实时数据监控金融数据分析金融服务
OKX MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于从 OKX 交易所获取实时加密货币数据。它允许 AI 助手(如 Claude)通过定义的工具访问最新的加密货币价格信息和历史数据,并提供增强的可视化功能和 WebSocket 实时更新。
View on GitHub

Overview

基本能力

产品定位

OKX MCP Server 主要用于提供加密货币的实时和历史数据,支持 AI 助手通过 MCP 协议访问这些数据,并提供丰富的可视化功能。

核心功能

  • get_price: 获取加密货币交易对的最新价格数据,支持可视化格式化
  • get_candlesticks: 检索历史 K 线数据,支持 ASCII 图表等可视化选项
  • subscribe_ticker: 订阅交易对的实时 WebSocket 更新
  • get_live_ticker: 从 WebSocket 连接获取最新的实时数据
  • unsubscribe_ticker: 停止接收特定交易对的更新

适用场景

  • 实时监控加密货币价格变动
  • 分析加密货币历史价格趋势
  • 设置价格警报
  • 实时市场波动跟踪
  • 基于最新数据做出交易决策

工具列表

  1. get_price: 获取加密货币交易对的最新价格数据,支持 markdownjson 格式
  2. get_candlesticks: 检索历史 K 线数据,支持 markdowntablejson 格式
  3. subscribe_ticker: 订阅交易对的实时 WebSocket 更新
  4. get_live_ticker: 获取活动订阅的最新数据,支持 markdownjson 格式
  5. unsubscribe_ticker: 结束对特定交易对的订阅

常见问题解答

  • 当前实现仅使用 OKX 的公共 API 端点,无需 API 密钥
  • 代码库中不存储敏感数据
  • 可以安全地将此代码提交到 Git

使用教程

使用依赖

  • Node.js (v16 或更高版本推荐)
  • npm 或 yarn
  • VSCode 与 Claude 扩展(如果使用 VSCode 集成)
  • Claude Desktop(如果不使用 VSCode)

安装教程

  1. 克隆仓库 bash git clone https://github.com/yourusername/okx-mcp-server.git cd okx-mcp-server
  2. 安装依赖 bash npm install
  3. 添加 WebSocket 依赖 bash npm install ws npm install --save-dev @types/ws
  4. 构建项目 bash npm run build
  5. 使编译后的脚本可执行 bash chmod +x build/index.js

调试方式

  1. 直接运行服务器 bash npm startbash node build/index.js
  2. 使用 MCP Inspector 测试 bash npx @modelcontextprotocol/inspector node build/index.js 在检查器中可以测试各种工具,如 get_priceget_candlesticks 等。

许可证

该项目遵循 MIT 开源许可条款。