
Other Tools
v0.1.0
active
mcp-okx
io.github.aahl/mcp-okx
MCP Server for okx.com
Documentation
🆗 OKX MCP Server
📲 Install
Method 1: uvx
{
"mcpServers": {
"mcp-okx": {
"command": "uvx",
"args": ["mcp-okx"],
"env": {
"OKX_API_KEY": "your-okx-api-key",
"OKX_API_SECRET": "api-secret-key",
"OKX_PASSPHRASE": "api-passphrase",
"OKX_TRADE_FLAG": "1", # 0: Production trading, 1: Demo trading
"OKX_BASE_URL": "https://www.okx.com", # Optional
"MCP_AUTH_TOKEN": "your-custom-token" # Default same as OKX_API_KEY
}
}
}
}
Method 2: Docker
mkdir /opt/mcp-okx
cd /opt/mcp-okx
wget https://raw.githubusercontent.com/aahl/mcp-okx/refs/heads/main/docker-compose.yml
docker-compose up -d
{
"mcpServers": {
"mcp-okx": {
"url": "http://0.0.0.0:8811/mcp", # Streamable HTTP
"headers": {
"Authorization": "Bearer your-okx-api-key-or-custom-token"
}
}
}
}
⚙️ Environment variables
OKX_API_KEY: API key of your OKX account. Please refer to my api page regarding API Key creation.OKX_API_SECRET: API secret key of your OKX account.OKX_PASSPHRASE: API passphrase of your OKX account.OKX_TRADE_FLAG: 0: Production trading, 1: Demo tradingOKX_BASE_URL: Base URL of OKX. Default:https://www.okx.comMCP_AUTH_TOKEN: Custom token for authentication. Default same asOKX_API_KEY
🛠️ Available Tools
Account Tools
account_config- Get account configurationaccount_balance- Get account balanceaccount_positions- Get account positionsaccount_position_risk- Get account position risk
Trading Tools
place_order- Place a new ordercancel_order- Cancel an incomplete orderget_trade_order- Get order detailsget_order_list- Get incomplete order listget_orders_history- Get Order Historyclose_positions- Liquidate all positions
Market Data
market_tickers- Get cryptocurrency rankings
PYPI
mcp-okxInstall Command
pip install mcp-okxOCI
ghcr.io/aahl/mcp-okx:latestInstall Command
docker pull ghcr.io/aahl/mcp-okx:latest:undefined