Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OKX_API_KEY | Yes | API key of your OKX account. Please refer to my api page regarding API Key creation. | |
| OKX_BASE_URL | No | Base URL of OKX. Default: https://www.okx.com | https://www.okx.com |
| MCP_AUTH_TOKEN | No | Custom token for authentication. Default same as OKX_API_KEY | |
| OKX_API_SECRET | Yes | API secret key of your OKX account. | |
| OKX_PASSPHRASE | Yes | API passphrase of your OKX account. | |
| OKX_TRADE_FLAG | Yes | 0: Production trading, 1: Demo trading |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| account_config | Retrieve current OKX account configuration. It is recommended to use this tool to obtain account configuration information before using all other tools |
| account_balance | Retrieve a list of assets (with non-zero balance), remaining balance, and available amount in the OKX trading account |
| account_positions | Retrieve information on your OKX positions. When the account is in net mode, net positions will be displayed, and when the account is in long/short mode, long or short positions will be displayed. Return in reverse chronological order using ctime. |
| account_position_risk | Obtain the overall holding risk of the OKX account |
| place_order | Place a new order on OKX for trading |
| cancel_order | Cancel an incomplete order on OKX |
| get_trade_order | Retrieve order details on OKX. For a detailed schema of the output object, please read the resource at: |
| get_order_list | Retrieve all incomplete orders under the current OKX account. For a detailed schema of the output object, please read the resource at: |
| get_orders_history | Get completed orders on OKX which are placed in the last 7 days, including those placed 7 days ago but completed in the last 7 days.The incomplete orders that have been canceled are only reserved for 2 hours. For a detailed schema of the output object, please read the resource at: |
| close_positions | Liquidate all positions in the designated trading product at market price on OKX |
| market_tickers | Retrieve the latest price snapshot, best bid/ask price, and trading volume in the last 24 hours.Get the ranking of coins with the highest increase or the largest trading volume. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| schema_trade_order | This resource is used to describe the schema of the trade order on OKX |