JinDaGe - okx-mcp-server MCP Details

article

README

🚀 OKX MCP 服务器

本项目搭建了一个 Model Context Protocol (MCP) 服务器，可从 OKX 交易所获取实时加密货币数据。该服务器允许像 Claude 这样的 AI 助手通过预设工具，访问最新的加密货币价格信息与历史数据，还具备增强的可视化功能和 WebSocket 实时更新能力。

✨ 主要特性

get_price：获取指定加密货币交易对的最新价格数据，并进行视觉格式化。
get_candlesticks：检索历史烛台数据，支持包括 ASCII 图表在内的多种可视化方式。
subscribe_ticker：订阅实时价格推送。
get_live_ticker：获取活动订阅的最新数据。
unsubscribe_ticker：取消指定订阅。

📦 安装指南

要运行此服务器，您需要以下环境：

Node.js（推荐使用版本 14 或更高）
npm 或 yarn
VSCode 和 Claude 扩展，或 Claude Desktop

具体安装步骤

克隆仓库：

git clone [仓库地址]
cd okx-mcp-server

安装依赖项：

npm install
# 或使用 yarn
yarn install

添加 WebSocket 依赖：

npm install ws
# 或使用 yarn
yarn add ws

构建项目：

npm run build
# 或使用 yarn
yarn build

赋予运行权限（可选）：

chmod +x server.js

💻 使用示例

运行服务器

node server.js
# 或使用 yarn
yarn start

使用 MCP Inspector 测试工具

要测试服务器功能，您可以使用 MCP Inspector：

安装 MCP Inspector：

npm install -g @okx/mcp-inspector

运行 Inspector：

mcp-inspector

代码示例

基础用法

// 获取比特币的价格信息
get_price("BTC-USDT", { format: "markdown" });

// 获取过去 24 小时的烛台数据
get_candlesticks("ETH-USDT", { interval: "1h", format: "table" });

高级用法

// 订阅 BTC-USDT 的实时价格更新
subscribe_ticker("BTC-USDT");

// 获取最新的实时数据
get_live_ticker();

// 取消订阅
unsubscribe_ticker("BTC-USDT");

📚 详细文档

集成

在 VSCode 中集成

打开 VSCode 并进入 Extensions（扩展）菜单。
搜索并安装 "Claude" 扩件。
启动服务器后，打开终端运行 mcp-inspector。

在 Claude Desktop 中集成

下载并安装 Claude Desktop：下载链接
启动服务器后，在 Claude Desktop 中选择 "Connect to MCP Server" 并输入服务器地址。

数据可视化功能

格式选项

get_price 支持 markdown（默认）或 json
get_candlesticks 支持 markdown（默认）、table 或 json
get_live_ticker 支持 markdown（默认）或 json

环境变量（可选）

如果扩展服务器以使用认证端点，可以添加以下环境变量：

OKX_API_KEY=your_api_key
OKX_API_SECRET=your_api_secret
OKX_API_PASSPHRASE=your_api_passphrase

安全注意事项

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

扩展服务器

可以考虑以下增强功能：

添加更多工具支持其他 OKX API 端点。
实现需要认证的端点，使用 API 密钥。
支持其他加密货币交易所。
增强可视化功能，添加复杂图表。
集成技术指标（RSI、MACD、移动平均线）。
添加多加密货币价格比较工具。
实现市场概览功能。

📄 许可证

MIT

okx-mcp-server