Skip to content

A MCP service designed to help developers easily access documentation when integrating with cryptocurrency exchange APIs MCP服务用于帮助开发者在开发加密货币交易所API对接时方便地查询文档

Notifications You must be signed in to change notification settings

flytam/exchange-sdk-mcp

Repository files navigation

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
Image Image

Currently Supported Exchanges

Exchange SDK Status
Gate.io SDK Docs
Bybit SDK Docs
Binance SDK Docs
Bitget SDK Docs
OKX SDK Docs
OKX DEX TODO

Configuration

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

Usage

This MCP service provides the following tools:

  1. Query Exchange SDK supported methods - Lists all available methods for the exchange SDK
  2. Query Exchange SDK method usage information - Gets detailed documentation for a specific method
  3. Query Exchange SDK README - Gets the README content of the exchange SDK project

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

About

A MCP service designed to help developers easily access documentation when integrating with cryptocurrency exchange APIs MCP服务用于帮助开发者在开发加密货币交易所API对接时方便地查询文档

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published