OKX Agent Trade Kit

English | 中文

OKX Agent Trade Kit — an AI-powered trading toolkit with two standalone packages:

Package	Description
okx-trade-mcp	MCP server for Claude / Cursor and any MCP-compatible AI client
okx-trade-cli	CLI for operating OKX from terminal

---

What is this?

OKX Agent Trade Kit connects AI assistants directly to your OKX account via the Model Context Protocol. Instead of switching between your AI and the exchange UI, you describe what you want — the AI calls the right tools and executes it.

It runs as a local process with your API keys stored only on your machine. No cloud services, no data leaving your device.

Features

Feature	Description
145 tools across 11 modules	Full trading lifecycle: market data → orders → algo orders → account management → earn → trading bots → event contracts → news → smart money signals
Algo orders built-in	Conditional, OCO take-profit/stop-loss, trailing stop
Safety controls	--read-only flag, per-module filtering, built-in rate limiter
Zero infrastructure	Local stdio process, no server or database required
MCP standard	Works with Claude Desktop, Cursor, openCxxW, and any MCP-compatible client
Agent Skills included	Pre-built skill files for AI agent frameworks — drop-in instructions covering market data, trading, portfolio, bots, and earn
Open source	MIT license, API keys never leave your machine

Modules

Module	Tools	Description	Docs
market	19	Ticker, orderbook, candles (+history), index ticker, index candles, price limit, funding rate, mark price, open interest, stock tokens, technical indicators (70+ indicators: MA/EMA/RSI/MACD/BB/ATR/KDJ/BTCRAINBOW/AHR999 and more — no auth required), indicator list, market filter (screen by price/change/marketCap/volume/fundingRate/OI), OI history, OI change filter	→
spot	13	Place/cancel/amend orders, batch orders, fills (+archive), order history (+archive), conditional orders, OCO	→
swap	17	Perpetual trading, batch orders, positions, leverage, conditional orders, OCO, trailing stop	→
futures	18	Delivery contract trading, positions, fills, order history, amend/close/leverage, batch orders, algo orders (TP/SL, OCO, trailing stop)	→
option	10	Options trading: place/cancel/amend/batch-cancel, order history, positions (with Greeks), fills, option chain, IV + Greeks	→
account	14	Balance, bills (+archive), positions, positions history, fee rates, config, position mode, max withdrawal, max avail size, audit log	→
event	9	Event contract trading: browse, series, events, markets (query); place, amend, cancel, orders, fills (private). Semantic outcome values: UP/YES/DOWN/NO	→
earn	23	Simple Earn: balance, purchase, redeem, lending rate, fixed-term orders (10). On-chain staking/DeFi (6). Dual Currency Deposit/双币赢 (6). Flash Earn (1). Sub-modules: earn.savings, earn.onchain, earn.dcd, earn.flash. Included in all.	→
bot	10	Trading bots: Grid (5) and DCA — Spot & Contract (5). Sub-modules: bot.grid, bot.dca	→
news	7	Crypto news: latest news, by-coin filter, full-text search, article detail, news sources, coin sentiment (snapshot + trend)	→
smartmoney	5	Smart money signals: multi-currency overview, single-currency consensus signal, signal history timeline, trader leaderboard, trader detail (composite) — all read-only	→

---

Quick Start

Prerequisites: Node.js >= 18

# 1. Install
npm install -g @okx_ai/okx-trade-mcp @okx_ai/okx-trade-cli

# 2. Configure OKX API credentials (interactive wizard)
okx config init

# 3. Register the MCP server with your AI client
okx-trade-mcp setup --client claude-desktop
okx-trade-mcp setup --client cursor
okx-trade-mcp setup --client claude-code
okx-trade-mcp setup --client vscode          # writes .mcp.json in current directory

Alternative: One-line install script — handles Node.js check, install, and client detection automatically.

For live trading, multiple profiles, or other clients, see configuration →.

---

okx-trade-mcp

okx-trade-mcp                                        # default: spot, swap, account
okx-trade-mcp --modules market                       # market data only (no auth needed)
okx-trade-mcp --modules spot,account                 # spot trading + account
okx-trade-mcp --profile live --modules all           # all modules including earn
okx-trade-mcp --read-only                            # query tools only, no writes

Startup scenarios → — VS Code · Windsurf →

---

okx-trade-cli

okx market ticker BTC-USDT
okx spot place --instId BTC-USDT --side buy --ordType market --sz 100
okx account balance

Naming note — CLI subcommands use spaces (okx swap algo place). AI agents see the same features under underscored MCP tool names (swap_place_algo_order). Do not convert MCP identifiers into hyphen-joined CLI commands — okx swap place-algo is not valid. See CLI reference · CLI vs MCP tool names.

Full CLI reference →

---

Agent Skills

Pre-built skill files for AI agent frameworks are included in the skills/ directory. Each skill tells the agent when to activate and how to use the okx CLI for a specific task category.

Skill	Description	Auth
okx-cex-market	Market data: prices, candles, order books, funding rates, technical indicators	No
okx-cex-trade	Order management: spot, swap, futures, options, algo orders	Yes
okx-cex-portfolio	Account: balances, positions, P&L, transfers	Yes
okx-cex-bot	Trading bots: grid and DCA (spot & contract)	Yes
okx-cex-earn	Earn: Simple Earn, On-chain staking, Dual Investment, AutoEarn	Yes
okx-cex-smartmoney	Smart Money: trader leaderboard, consensus signals, position analysis	Yes

Skills documentation →

---

Reporting Issues

If a tool call or CLI command fails, open an issue and include the full error output.

MCP — copy the structured error block shown in your AI client:

{
  "tool": "swap_place_order",
  "error": true,
  "type": "OkxApiError",
  "code": "51020",
  "message": "Order quantity invalid",
  "endpoint": "POST /api/v5/trade/order",
  "traceId": "abc123def456",
  "timestamp": "2026-03-03T10:00:00.000Z",
  "serverVersion": "1.0.4"
}

CLI — paste the full stderr output:

Error: Order quantity invalid
TraceId: abc123def456
Hint: Check order size against instrument minSz.
Version: okx-trade-cli@1.0.4

See FAQ → for common issues.

---

Build from Source

git clone https://github.com/okx/agent-tradekit.git && cd okx-trade-mcp
pnpm install && pnpm build

See CONTRIBUTING.md for the full development guide.

packages/
├── core/    # shared client & tools
├── mcp/     # MCP Server
└── cli/     # CLI tool

---

Documentation

Document	Description
Architecture	System design and module overview
Contributing	Development setup and PR guidelines
Changelog	Version history
Agent Skills	Pre-built skills for AI agent frameworks
Security	Vulnerability reporting