OKX MCP Server
OKX MCP 服务器
提供来自 OKX 交易所的实时加密货币价格数据的模型上下文协议服务器。
特征
该 MCP 服务器连接到 OKX API,通过简单的工具界面提供加密货币价格信息。它通过 OKX 的 API 提供全面的错误处理、请求日志记录和速率限制。
工具
get_candlesticks
检索 OKX 上任何工具的历史烛台(OHLCV)数据。
输入:
instrument:字符串(必需)- 工具 ID(例如“BTC-USDT”)bar:字符串(可选) - 时间间隔(例如“1m”、“5m”、“1H”、“1D”),默认“1m”limit:数字(可选) - 返回的烛台数量(最多 100 个),默认 100
输出:JSON 对象数组,每个对象包含:
timestamp:烛台的 ISO 时间戳open:开盘价high:最高价格low:最低价格close:收盘价volume:交易量volumeCurrency:以货币计算的交易量
使用示例:
[
{
"timestamp": "2025-03-07T17:00:00.000Z",
"open": "87242.8",
"high": "87580.2",
"low": "86548.0",
"close": "87191.8",
"volume": "455.72150427",
"volumeCurrency": "39661166.242091111"
}
]get_price
获取 OKX 上任何工具的最新价格和 24 小时市场数据。
输入:
instrument:字符串(必需)- 工具 ID(例如“BTC-USDT”)
输出:JSON 对象包含:
instrument:请求的仪器 IDlastPrice:最新成交价bid:当前最佳出价ask:当前最佳卖价high24h:24小时最高价low24h:24小时最低价volume24h:24小时交易量timestamp:数据的 ISO 时间戳
使用示例:
{
"instrument": "BTC-USDT",
"lastPrice": "65432.1",
"bid": "65432.0",
"ask": "65432.2",
"high24h": "66000.0",
"low24h": "64000.0",
"volume24h": "1234.56",
"timestamp": "2024-03-07T17:22:28.000Z"
}Related MCP server: OKX MCP Server
发展
安装依赖项:
npm install构建服务器:
npm run build对于使用自动重建的开发:
npm run watch安装
要与 Claude Desktop 或 VSCode 一起使用,请将服务器配置添加到您的 MCP 设置中:
macOS(VSCode):
~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.jsonmacOS(克劳德桌面):
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows(VSCode):
%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.jsonWindows(Claude 桌面):
%APPDATA%/Claude/claude_desktop_config.json配置:
{
"mcpServers": {
"okx": {
"command": "node",
"args": ["/path/to/okx-mcp-server/build/index.js"],
"disabled": false,
"autoApprove": []
}
}
}错误处理
服务器实现了全面的错误处理:
捕获网络错误并返回上下文
无效的仪器 ID 返回相应的错误消息
通过 axios 超时配置来实现 API 速率限制
所有错误均已记录,以用于调试目的
Available Tools
2 toolsget_candlesticksC
Get candlestick data for an OKX instrument
| Name | Required | Description | Default |
|---|---|---|---|
| instrument | Yes | Instrument ID (e.g. BTC-USDT) | |
| bar | No | Time interval (e.g. 1m, 5m, 1H, 1D) | 1m |
| limit | No | Number of candlesticks (max 100) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure but only states what the tool does without mentioning rate limits, authentication needs, response format, or pagination behavior. It doesn't explain what 'candlestick data' includes (e.g., OHLC values) or any constraints beyond the implied data retrieval.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that directly states the tool's purpose without any unnecessary words. It's front-loaded and appropriately sized for a simple data retrieval tool, with every word contributing to clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description is incomplete for a tool with three parameters. It doesn't cover behavioral aspects like response format, error handling, or usage context, leaving significant gaps for an AI agent to understand how to effectively invoke and interpret results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all three parameters. The description adds no additional meaning beyond the schema, such as explaining the significance of candlestick intervals or instrument IDs in context. This meets the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('Get') and resource ('candlestick data for an OKX instrument'), making the purpose immediately understandable. However, it doesn't differentiate from the sibling tool 'get_price', which likely provides different market data, leaving room for improvement in distinguishing between similar data retrieval functions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus the sibling 'get_price' or any alternatives. It lacks context about when candlestick data is appropriate (e.g., for charting, technical analysis) versus price data, offering no usage boundaries or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_priceC
Get latest price for an OKX instrument
| Name | Required | Description | Default |
|---|---|---|---|
| instrument | Yes | Instrument ID (e.g. BTC-USDT) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It states what the tool does but lacks details on traits like rate limits, authentication needs, error handling, or response format. This is a significant gap for a tool with no annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence with zero waste. It is appropriately sized and front-loaded, clearly stating the tool's purpose without unnecessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description is incomplete. It doesn't explain behavioral traits, return values, or usage context, which are essential for a tool that fetches financial data. This leaves clear gaps in understanding.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents the 'instrument' parameter. The description adds no additional meaning beyond what the schema provides, such as examples or constraints, meeting the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get' and resource 'latest price for an OKX instrument', making the purpose specific and understandable. It doesn't explicitly distinguish from the sibling 'get_candlesticks', which provides historical price data, so it misses full differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'get_candlesticks'. There is no mention of prerequisites, context, or exclusions, leaving usage unclear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
2 tool updates
v1.0.0- Added
get_candlesticks - Added
get_price
TDQS
Scored across 2 tools
The two tools have distinct purposes: get_candlesticks retrieves historical price data in candlestick format, while get_price fetches the latest price. There is minimal overlap as they target different data types (historical vs. current), though both relate to instrument pricing which could cause slight confusion in some contexts.
Both tools follow a consistent verb_noun naming pattern (get_candlesticks, get_price) with clear, descriptive names. The snake_case style is uniform throughout, making the tools easy to identify and predict.
With only 2 tools, the server feels severely under-scoped for a financial trading platform like OKX. This minimal set lacks essential operations such as placing orders, managing accounts, or accessing market depth, which are core to trading workflows.
The tool surface is highly incomplete for an OKX server, covering only price data retrieval. There are significant gaps in trading functionality (e.g., no create_order, cancel_order), account management, or market data beyond basic prices, which will likely cause agent failures in typical trading scenarios.
Maintenance
Related MCP Connectors
Real-time crypto market data: candles, tickers, orderbooks across 13+ exchanges via MCP.
Real-time crypto prices from Binance, Coinbase, Kraken, OKX, and Bybit
Provide real-time cryptocurrency price data and market analysis.
Verified market data for AI trading agents: quality-flagged candles, funding, OI, order flow. x402.
Related MCP Servers
- AlicenseBqualityFmaintenanceA Model Context Protocol server that provides read-only access to Bybit's cryptocurrency exchange API, allowing users to query real-time cryptocurrency data using natural language.121116MIT
- -licenseBqualityDmaintenanceProvides real-time cryptocurrency price data from OKX exchange through a Model Context Protocol interface.2-
- AlicenseBqualityDmaintenanceProvides real-time and historical cryptocurrency price data from the OKX exchange, including live WebSocket updates, candlestick charts, and visual price analysis for trading pairs.573MIT
- FlicenseBqualityDmaintenanceProvides access to Tastytrade historical price data via the Model Context Protocol. It enables users to retrieve historical candle data for specific financial symbols and time intervals.1-