Skip to main content
Glama
Crypto Exchange SDK Documentation MCP

Crypto Exchange SDK Documentation MCP

by flytam

Crypto Exchange SDK Documentation MCP

npm version GitHub Actions Workflow Status

中文文档

A Model Context Protocol (MCP) service designed to help developers easily access documentation when integrating with cryptocurrency exchange APIs. This tool provides comprehensive offline documentation for multiple cryptocurrency exchanges, making it convenient to query API methods and usage information without requiring an internet connection.

Features

  • Query available methods from cryptocurrency exchange SDKs

  • Retrieve detailed documentation for specific methods

  • Offline documentation - all documentation is available offline, no internet connection required

Related MCP server: OKX MCP Server

Currently Supported Exchanges

Configuration

{
  "mcpServers": {
    "crypto-exchange-mcp": {
      "command": "npx",
      "args": ["-y", "crypto-exchange-mcp@latest"]
    }
  }
}

Usage

This MCP service provides the following tools for each exchange:

Gate.io

  • gate_methods - Get all API method lists and related documentation supported by Gate Exchange SDK

  • gate_method_detail - Query detailed usage information for specific API methods in Gate Exchange SDK

OKX

  • okx_methods - Get all API method lists and related documentation supported by OKX Exchange SDK

  • okx_method_detail - Query detailed usage information for specific API methods in OKX Exchange SDK

OKX DEX

  • okx_dex_api_methods - Get all API method lists and related documentation supported by OKX DEX API

  • okx_dex_api_method_detail - Query detailed usage information for specific API methods in OKX DEX API

Bybit

  • bybit_methods - Get all API method lists and related documentation supported by Bybit Exchange SDK

  • bybit_method_detail - Query detailed usage information for specific API methods in Bybit Exchange SDK

Binance

  • binance_methods - Get all API method lists and related documentation supported by Binance Exchange SDK

  • binance_method_detail - Query detailed usage information for specific API methods in Binance Exchange SDK

Bitget

  • bitget_methods - Get all API method lists and related documentation supported by Bitget Exchange SDK

  • bitget_method_detail - Query detailed usage information for specific API methods in Bitget Exchange SDK

Architecture

The service is designed with extensibility in mind, making it easy to add support for new exchanges in the future. Each exchange is implemented as an adapter following a common interface, making it simple to add support for new exchanges.

Requirements

  • Node.js >= 22

Development

# Install dependencies
pnpm install

Build the project

pnpm run build

Development mode (watch for changes)

pnpm run dev

Test with MCP inspector

pnpm run inspect

Generate offline data for exchanges

pnpm run generateOfflineData

Contributing

Contributions are welcome! If you'd like to add support for a new exchange, please follow the adapter pattern established in the codebase.

License

MIT

Available Tools

12 tools
binance_method_detailB

Query detailed usage information for specific API methods in Binance Exchange SDK. Provides complete technical documentation including request parameters, response formats, usage examples, error handling, etc., helping developers correctly integrate and use corresponding API interfaces.

Inputs: method (required).

binance_methodsA

Get all API method lists and related documentation supported by Binance Exchange SDK. This tool returns a complete method inventory, including basic descriptions and usage instructions for each method, helping developers understand available functional interfaces.

bitget_method_detailA

Query detailed usage information for specific API methods in Bitget Exchange SDK. Provides complete technical documentation including request parameters, response formats, usage examples, error handling, etc., helping developers correctly integrate and use corresponding API interfaces.

Inputs: method (required).

bitget_methodsA

Get all API method lists and related documentation supported by Bitget Exchange SDK. This tool returns a complete method inventory, including basic descriptions and usage instructions for each method, helping developers understand available functional interfaces.

bybit_method_detailA

Query detailed usage information for specific API methods in Bybit Exchange SDK. Provides complete technical documentation including request parameters, response formats, usage examples, error handling, etc., helping developers correctly integrate and use corresponding API interfaces.

Inputs: method (required).

bybit_methodsA

Get all API method lists and related documentation supported by Bybit Exchange SDK. This tool returns a complete method inventory, including basic descriptions and usage instructions for each method, helping developers understand available functional interfaces.

gate_method_detailA

Query detailed usage information for specific API methods in Gate Exchange SDK. Provides complete technical documentation including request parameters, response formats, usage examples, error handling, etc., helping developers correctly integrate and use corresponding API interfaces.

Inputs: method (required).

gate_methodsA

Get all API method lists and related documentation supported by Gate Exchange SDK. This tool returns a complete method inventory, including basic descriptions and usage instructions for each method, helping developers understand available functional interfaces.

okx_dex_api_method_detailA

Query detailed usage information for specific API methods in OKX DEX API. Provides complete technical documentation including request parameters, response formats, usage examples, error handling, etc., helping developers correctly integrate and use corresponding API interfaces.

Inputs: method (required).

okx_dex_api_methodsA

Get all API method lists and related documentation supported by OKX DEX API. This tool returns a complete method inventory, including basic descriptions and usage instructions for each method, helping developers understand available functional interfaces.

okx_method_detailA

Query detailed usage information for specific API methods in OKX Exchange SDK. Provides complete technical documentation including request parameters, response formats, usage examples, error handling, etc., helping developers correctly integrate and use corresponding API interfaces.

Inputs: method (required).

okx_methodsA

Get all API method lists and related documentation supported by OKX Exchange SDK. This tool returns a complete method inventory, including basic descriptions and usage instructions for each method, helping developers understand available functional interfaces.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4/5.0

    Scored across 12 tools

    Disambiguation5/5

    Each tool is clearly scoped to a specific exchange and operation: '_methods' lists available methods while '_method_detail' provides details for a selected method. Exchange names in the tool names eliminate any possible overlap or confusion.

    Naming Consistency5/5

    All tool names follow a predictable pattern: {exchange}_methods and {exchange}_method_detail. The naming is uniformly lowercase snake_case, and even the okx_dex_api variant still follows the same structural convention.

    Tool Count5/5

    With 12 tools covering 6 exchanges (2 per exchange), the count is well-scoped for a documentation server. Each tool has a distinct role, and the count is neither bloated nor thin.

    Completeness5/5

    The tool set fully covers its documentation purpose: for every supported exchange, you can retrieve a full method list and then drill into detailed documentation for any specific method. No obvious missing operations or dead ends.

    Maintenance

    ActivityInactive
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      Interact seamlessly with the Bybit API to fetch market data, manage your account, and execute trades. Leverage powerful tools to enhance your trading experience and automate your strategies effortlessly. If you wish to use an API key restricted to your personal IP address, you must configure the MCP
      15
      9
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      Enables interaction with OKX cryptocurrency exchange through account management, trading operations (place/cancel orders, close positions), and market data retrieval with support for both production and demo trading modes.
      11
      87 PyPI
      2
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Exposes the full Gate API v4 to MCP clients with 384 tools for spot, futures, margin, wallet, and more. Supports both public endpoints (no auth) and authenticated trading operations.
      330 npm
      1
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      Provides tools to query OKX cryptocurrency exchange data including instruments, tickers, candles, funding rates, and mark prices via MCP.
      195 npm
      MIT