Okx MCP

🚀 OKX MCP Server

An MCP (Model Context Protocol) server that provides real-time cryptocurrency price data, fetching information from the OKX exchange.

🚀 Quick Start

This MCP server connects to the OKX API and offers cryptocurrency price information through a simple tool interface. It includes comprehensive error handling, request logging, and rate limiting implemented via the OKX API.

✨ Features

• Connects to the OKX API to provide cryptocurrency price information.
• Incorporates comprehensive error handling, request logging, and rate limiting through the OKX API.

💻 Usage Examples

Tools

get_candlesticks

Retrieve historical candlestick (OHLCV) data for any OKX instrument.

• Input:
  • instrument: String (Required) - Instrument ID (e.g., "BTC-USDT")
  • bar: String (Optional) - Time interval (e.g., "1m", "5m", "1H", "1D"), default is "1m"
  • limit: Number (Optional) - Number of candlesticks to return (maximum 100), default is 100
• Output: An array of JSON objects containing the following fields:
  • timestamp: ISO timestamp of the candlestick
  • open: Opening price
  • high: Highest price
  • low: Lowest price
  • close: Closing price
  • volume: Trading volume
  • volumeCurrency: Trading volume in currency

Example usage:

[
  {
    "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

Get the latest price and 24-hour market data for any OKX instrument.

• Input:
  • instrument: String (Required) - Instrument ID (e.g., "BTC-USDT")
• Output: A JSON object containing the following fields:
  • instrument: Requested instrument ID
  • lastPrice: Latest trading price
  • bid: Current best bid price
  • ask: Current best ask price
  • high24h: 24-hour highest price
  • low24h: 24-hour lowest price
  • volume24h: 24-hour trading volume
  • timestamp: ISO timestamp of the data

Example usage:

{
  "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"
}

📦 Installation

Development

Install dependencies:

npm install

Build the server:

npm run build

Develop with auto-rebuild:

npm run watch

Configuration

When using with Claude Desktop or VSCode, add the server configuration to the MCP settings:

macOS (VSCode):

~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

macOS (Claude Desktop):

~/Library/Application Support/Claude/claude_desktop_config.json

Windows (VSCode):

%APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

Windows (Claude Desktop):

%APPDATA%/Claude/claude_desktop_config.json

Configuration:

{
  "mcpServers": {
    "okx": {
      "command": "node",
      "args": ["/path/to/okx-mcp-server/build/index.js"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

Error Handling

The server implements comprehensive error handling:

• Captures network errors and returns them with context.
• Returns an error for invalid instrument IDs.
• By default, all responses include code and message fields.