0xAuto OKX MCP Server

0xAuto OKX MCP 服务

此服务基于 Model Context Protocol（MCP），为 OKX V5 API 和 OKX DEX API 提供工具接口层，让 AI Agent 能够更便捷地访问 OKX 交易所（CEX）和去中心化交易所（DEX）功能。

功能特性

CEX（中心化交易所）功能

• 隐藏复杂的 OKX API 身份验证和签名逻辑
• 提供标准的 MCP 工具接口
• 涵盖核心功能：
  • 账户信息（余额、持仓、历史记录）
  • 市场数据（行情、K 线）
  • 交易操作（下单、撤单、订单管理）
  • 资金操作（充值地址、提现）

DEX（去中心化交易所）功能

• 提供对 OKX DEX 聚合器的访问

• 支持多链交易和代币兑换

• 涵盖以下功能：

  • 获取代币报价
  • 查询代币价格和 K 线数据
  • 查询链上余额
  • 代币授权操作
  • 链内和跨链兑换

• 标准化的 JSON 响应和错误处理

• 支持 MCP 协议会话管理和流式传输

系统要求

• Node.js（v16 或更高版本）
• pnpm

安装步骤

1. 安装依赖：

   pnpm install
   

2. 设置环境变量： 复制 .env.example 中的内容，创建 .env 文件：

   cp .env.example .env
   

   编辑 .env 文件，填写 OKX API 凭证和其他设置：

   # OKX API Configuration
   OKX_API_KEY=your_okx_api_key
   OKX_SECRET_KEY=your_okx_secret_key
   OKX_PASSPHRASE=your_okx_api_password
   OKX_API_BASE_URL=https://www.okx.com
   OKX_DEX_API_BASE=https://web3.okx.com/api/v5/dex
   
   # Simulated trading: 0 for live trading, 1 for demo account
   SIMULATED_TRADING=0
   
   SERVER_PORT=3000
   LOG_LEVEL=info
   

   重要提示： 确保你的 OKX API Key 具备必要的权限（读取、交易）。

运行服务

pnpm start
# or development mode
pnpm dev

服务将在 SERVER_PORT 指定的端口上启动（默认为 3000）。

MCP 工具列表

此服务实现了以下 MCP 工具：

CEX（中心化交易所）工具

账户相关工具

• okx_get_account_info - 获取账户信息
• okx_get_positions - 获取持仓信息
• okx_get_balance - 获取账户余额

交易相关工具

• okx_place_order - 下达交易订单
• okx_cancel_order - 撤销订单
• okx_get_orders - 获取订单信息
• okx_get_order_history - 获取历史订单

市场数据工具

• okx_get_ticker - 获取市场行情
• okx_get_kline - 获取 K 线数据
• okx_get_instruments - 获取产品列表

资金相关工具

• okx_get_deposit_address - 获取充值地址
• okx_get_deposit_history - 获取充值记录
• okx_withdraw - 提现

DEX（去中心化交易所）工具

报价和市场数据

• okx_get_quote - 获取 OKX DEX 聚合器报价（支持设置滑点）
• okx_get_supported_chains - 获取 OKX DEX 支持的链
• okx_get_token_list - 获取 OKX DEX 支持的代币列表
• okx_get_price - 获取 OKX DEX 上代币的最新价格
• okx_get_kline - 获取 OKX DEX 上代币的 K 线数据（支持不同时间粒度）

交易相关工具

• okx_approve_transaction - 获取 OKX DEX 授权交易信息
• okx_swap - 发起 OKX DEX 兑换
• okx_cross_chain_swap - 发起 OKX DEX 跨链兑换

余额查询

• okx_get_balance - 获取指定链上某个钱包地址的所有代币余额

项目结构

src/
├── app.js              # Express application configuration
├── index.js            # Server startup entry
├── server.js           # MCP server creation and tool registration
├── config/             # Configuration files
├── controllers/        # Controller logic
├── middleware/         # Middleware
├── services/           # Service layer
│   ├── okxService.js   # OKX CEX API service
│   └── okxDexService.js# OKX DEX API service
├── tools/              # MCP tool implementation
│   ├── accountTools.js # CEX account tools
│   ├── fundingTools.js # CEX funding tools
│   ├── marketTools.js  # CEX market tools
│   ├── tradeTools.js   # CEX trading tools
│   ├── dexTools.js     # DEX tool registration
│   └── dex/            # DEX tool files
│       ├── quoteTool.js         # Quote tool
│       ├── supportedChainsTool.js# Supported chains tool
│       ├── tokenListTool.js     # Token list tool
│       ├── priceTool.js         # Price tool
│       ├── klineTool.js         # K-line tool
│       ├── balanceTool.js       # Balance tool
│       ├── approveTool.js       # Approval tool
│       ├── swapTool.js          # Swap tool
│       └── crossChainSwapTool.js# Cross-chain swap tool
└── utils/              # Utility functions

MCP 客户端连接

MCP 客户端可通过以下端点与服务通信：

• /mcp - MCP 主请求端点
• /sse - 向后兼容的 SSE 端点
• /messages - 向后兼容的消息端点

使用标准的 MCP 会话管理，包括会话 ID 和初始化请求。