Okx MCP Server

🚀 OKX MCP Server

This project creates a Model Context Protocol (MCP) server for fetching real-time cryptocurrency data from the OKX exchange. The server allows AI assistants like Claude to access the latest cryptocurrency price information and historical data through defined tools, and provides enhanced visualization features and WebSocket real-time updates.

✨ Features

• get_price: Retrieve the latest price data of a specific cryptocurrency trading pair with visual formatting.
• get_candlesticks: Fetch historical candlestick data, supporting multiple visualization methods including ASCII charts.
• subscribe_ticker: Subscribe to real-time price pushes.
• get_live_ticker: Obtain the latest data from active subscriptions.
• unsubscribe_ticker: Cancel a specific subscription.

📋 Prerequisites

To run this server, you need the following environment:

• Node.js (version 14 or higher is recommended).
• npm or yarn.
• VSCode and the Claude extension, or Claude Desktop.

📦 Installation

1. Clone the repository:

   git clone [repository URL]
   cd okx-mcp-server
   

2. Install dependencies:

   npm install
   # Or use yarn
   yarn install
   

3. Add WebSocket dependencies:

   npm install ws
   # Or use yarn
   yarn add ws
   

4. Build the project:

   npm run build
   # Or use yarn
   yarn build
   

5. Grant execution permissions (optional):

   chmod +x server.js
   

💻 Usage Examples

Basic Usage - Run the server

node server.js
# Or use yarn
yarn start

Advanced Usage - Use the MCP Inspector testing tool

To test the server's functionality, you can use the MCP Inspector:

1. Install the MCP Inspector:

   npm install -g @okx/mcp-inspector
   

2. Run the Inspector:

   mcp-inspector
   

📚 Integration

Integration in VSCode

1. Open VSCode and go to the Extensions menu.
2. Search for and install the "Claude" extension.
3. After starting the server, open the terminal and run mcp-inspector.

Integration in Claude Desktop

1. Download and install Claude Desktop: Download Link
2. After starting the server, select "Connect to MCP Server" in Claude Desktop and enter the server address.

💻 Usage Examples - Code Examples

Basic Usage

// Get the price information of Bitcoin
get_price("BTC-USDT", { format: "markdown" });

// Get the candlestick data of the past 24 hours
get_candlesticks("ETH-USDT", { interval: "1h", format: "table" });

Advanced Usage

// Subscribe to real-time price updates for BTC-USDT
subscribe_ticker("BTC-USDT");

// Get the latest real-time data
get_live_ticker();

// Cancel the subscription
unsubscribe_ticker("BTC-USDT");

🔧 Environment Variables (Optional)

If you extend the server to use authenticated endpoints, you can add the following environment variables:

OKX_API_KEY=your_api_key
OKX_API_SECRET=your_api_secret
OKX_API_PASSPHRASE=your_api_passphrase

⚠️ Security Notes

• The current implementation only uses OKX's public API endpoints and does not require an API key.
• No sensitive data is stored in the code.
• You can safely commit this code to a Git repository.

🚀 Server Enhancement

You can consider the following enhancements:

1. Add more tools to support other OKX API endpoints.
2. Implement authenticated endpoints using API keys.
3. Support other cryptocurrency exchanges.
4. Enhance visualization features by adding complex charts.
5. Integrate technical indicators (RSI, MACD, moving averages).
6. Add a multi-cryptocurrency price comparison tool.
7. Implement a market overview function.

📄 License

MIT