Skip to content

README.md

Latest commit

 

History

History
62 lines (46 loc) · 2.91 KB

README.md

File metadata and controls

62 lines (46 loc) · 2.91 KB
Raw

English | 中文

Agent Skills

Pre-built skills for AI agents to operate OKX via the okx CLI. Each skill is a self-contained Markdown file with YAML frontmatter that tells the agent when to activate and how to execute tasks.

Skills

Skill Description Auth Required
okx-cex-market Public market data: prices, order books, candles, funding rates, open interest, instruments, technical indicators No
okx-cex-trade Order management: spot, perpetual swap, delivery futures, options, TP/SL and trailing stop algo orders Yes
okx-cex-portfolio Account operations: balances, positions, P&L, fees, fund transfers Yes
okx-cex-bot Automated strategies: spot/contract grid bots and DCA (Spot & Contract) bots Yes
okx-cex-earn Earn products: Simple Earn, On-chain staking, Dual Investment (双币赢), AutoEarn Yes

Requirements

  • okx CLI installed: 
    npm install -g @okx_ai/okx-trade-cli
  • For authenticated skills: OKX API credentials configured in ~/.okx/config.toml: 
    okx config init

Skill Format

Each skill is a Markdown file with a YAML frontmatter header:

---
name: skill-name
description: "Trigger description for the AI agent routing system."
license: MIT
metadata:
  author: okx
  version: "1.0.0"
  agent:
    requires:
      bins: ["okx"]
---

The description field is used by the agent routing system to decide when to activate the skill. Skills with references/ subdirectories use {baseDir} as a runtime-resolved path variable pointing to that skill's directory.

description length limit: Codex CLI enforces a 1024-character maximum on this field. Descriptions that exceed this limit prevent Codex from loading the skill pack. Keep descriptions under 900 chars to leave headroom for future trigger additions. A CI test (packages/cli/test/skill-description-length.test.ts) enforces the 1024-char ceiling automatically.

Contributing

To add or improve a skill:

  1. Follow the existing SKILL.md structure (frontmatter + prerequisites + command index + operation flow)
  2. Place reference files in a references/ subdirectory if the skill is large
  3. List all distinct user-intent triggers in description as concisely as possible — combine redundant enumerations (e.g. "buy call"/"sell put"/"buy call option" → "buy call/put") rather than listing every variant separately; completeness of intent coverage drives routing accuracy
  4. Target ≤ 900 chars to leave headroom for future additions; hard ceiling is 1024 chars (enforced by CI)
  5. See CONTRIBUTING.md for branch and review conventions

License

MIT — see LICENSE.