Server · #288 trending MCP repo

Agent Trade Kit

okx/agent-trade-kit

OKX trading MCP server — connect AI agents to spot, swap, futures, options & grid bots via the Model Context Protocol.

Stars
502
This week
—
Forks
82
Open issues
4
Skills inside
10

Inside this repo

10 skills

earn-hunterAutomatically monitors OKX Flash Earn, Fixed Earn and Flexible Earn opportunities, sends push notifications, and guides subscription. 自动监控 OKX 闪赚、定期和活期赚币机会,推送通知并引导申购。Use when user says: 有闪赚通知我, 监控赚币, monitor earn, notify me about earn, 定时检查理财, 执行 earn-hunter 扫描, earn-hunter scan, 活期年化高了通知我, 监控活期.skills/earn-hunterokx-cex-authUse this skill when the user wants to 'login/log in/sign in', 'authenticate', 'authorize', 'connect OKX account', 'set up credentials', 'first time setup', 'configure okx', '登录', '授权', '认证', '连接账户', '首次配置'. Also when any OKX CLI command fails with an auth error: 'Run okx auth login first', 'Session skills/okx-cex-authokx-cex-botManage Grid bots (spot/contract/coin-margined), DCA Martingale bots (Spot DCA 现货马丁 / Contract DCA 合约马丁), and Smart Portfolio bots (智能组合, auto-rebalancing multi-asset portfolio) on OKX. Covers create, stop, amend, monitor P&L, TP/SL, margin/investment adjustment, AI-recommended parameters, and recommskills/okx-cex-botokx-cex-earnManages OKX Simple Earn (flexible savings/lending), Flash Earn, On-chain Earn (staking/DeFi), Dual Investment (DCD/双币赢), and AutoEarn (自动赚币) via the okx CLI. Use this skill whenever the user wants to check earn balances, browse flash-earn projects, subscribe or redeem earn products, view or set lendskills/okx-cex-earnokx-cex-marketUse this skill when the user asks for: price of any asset, ticker, order book, candles, OHLCV, funding rate, open interest, OI change scanner, market screener (top movers, high-volume, newly listed), mark price, index price, recent trades, instrument list, stock tokens, metals prices (gold, XAU, XAGskills/okx-cex-marketokx-cex-portfolioThis skill should be used when the user asks about 'account balance', 'how much USDT do I have', 'my funding account', 'show my positions', 'open positions', 'position P&L', 'unrealized PnL', 'closed positions', 'position history', 'realized PnL', 'account bills', 'transaction history', 'trading feeskills/okx-cex-portfoliookx-cex-skill-mpUse this skill when the user asks to: 'find a trading skill', 'search for skills', 'install a skill', 'add a skill', 'download a skill', 'browse skill marketplace', 'what skills are available', 'update a skill', 'check for skill updates', 'remove a skill', 'uninstall a skill', 'list installed skillsskills/okx-cex-skill-mpokx-cex-smartmoneySmart Money analytics on OKX: leaderboard traders, position tracking, trade records, closed-position history, aggregated consensus signals, and signal history. Use this skill when the user asks about 聪明钱, smart money, 牛人榜, leaderboard, top traders, 交易员排行, trader ranking, trader positions, trader PnLskills/okx-cex-smartmoneyokx-cex-tradeUse when the user asks to 'buy BTC', 'sell ETH', 'place a limit order', 'place a market order', 'cancel my order', 'amend my order', 'long BTC perp', 'short ETH swap', 'open a position', 'close a position', 'set take profit', 'limit take profit', 'immediate TP', 'set stop loss', 'self-trade preventiskills/okx-cex-tradeokx-sentiment-trackerUse this skill when the user asks about: 'any crypto news', 'latest news', 'market update', 'daily briefing', 'BTC news', 'ETH news', 'news on SOL', 'search SEC ETF', 'regulation news', 'Bitcoin halving', 'is BTC bullish or bearish', 'coin sentiment', 'sentiment trend', 'trending coins', 'top bullisskills/okx-sentiment-tracker

Documentation

README

View on GitHub ↗

OKX Agent Trade Kit

CI codecov npm: mcp npm downloads: mcp npm: cli npm downloads: cli License: MIT

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
170 tools across 11 modules (17 sub-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 24 Simple Earn: balance, purchase, redeem, lending rate, fixed-term products query, 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 18 Trading bots: Grid (9) and DCA — Spot & Contract (9). 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 10 Smart money analytics: leaderboard ranking, trader performance / positions / position history / order history, top-coin signals, single-asset signal (by coin / by traders), signal history (by coin / by traders) — all read-only, split by entry mode for AI-agent disambiguation →

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