项目简介

Binance MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型(LLM)应用提供实时的币安(Binance)交易所市场数据。它通过 WebSocket 连接币安 API,并以 MCP 协议标准化的方式向客户端提供市场数据,例如交易数据、价格变动、K线数据等。

主要功能点

  • 实时市场数据流: 通过 WebSocket 提供币安交易所现货和期货市场的实时数据更新。
  • 支持现货和期货市场: 同时支持币安现货和期货市场的多种数据类型。
  • 数据获取工具: 提供工具接口,允许客户端通过 MCP 协议请求获取特定交易对的市场数据和历史K线数据。
  • WebSocket 订阅工具: 支持客户端通过 MCP 协议订阅实时市场数据流,推送数据更新。
  • 错误处理和重连机制: 具备完善的错误处理机制和 WebSocket 自动重连功能,确保数据连接的稳定性。

安装步骤

  1. 确保已安装 Node.js 和 npm。

  2. 克隆仓库或下载代码到本地。

  3. 在项目根目录下打开终端,运行以下命令安装依赖:

    npm install

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Binance MCP Server:

{
  "serverName": "binance-market-data",
  "command": "npm",
  "args": ["start"]
}

配置参数说明:

  • 'serverName': 服务器名称,设置为 'binance-market-data' (取自 'config.ts' 中的 'NAME' 字段).
  • 'command': 启动服务器的命令,这里使用 'npm',因为 'package.json' 中配置了 'start' 脚本。
  • 'args': 启动命令的参数,这里使用 '["start"]' 来执行 'npm start' 脚本。

注意:

  • Binance MCP Server 默认监听标准输入/输出 (stdio) 进行 MCP 通信。
  • 无需额外配置端口或地址,MCP 客户端通过 stdio 与服务器进行交互。

基本使用方法

  1. 启动 Binance MCP Server。在项目根目录下打开终端,运行以下命令:

    npm start

    服务器成功启动后,会输出 "Binance MCP server started successfully" 的日志信息。

  2. 在 MCP 客户端中,配置上述服务器配置信息,建立与 Binance MCP Server 的连接。

  3. 通过 MCP 客户端,可以调用以下工具获取数据:

    • 'get_market_data': 获取交易对的市场数据,例如:

      {
        "tool_name": "get_market_data",
        "arguments": {
          "symbol": "BTCUSDT",
          "type": "spot"
        }
      }
    • 'get_klines': 获取交易对的历史 K 线数据,例如:

      {
        "tool_name": "get_klines",
        "arguments": {
          "symbol": "BTCUSDT",
          "type": "spot",
          "interval": "1h",
          "limit": 100
        }
      }
    • 'subscribe_market_data': 订阅交易对的实时市场数据流,例如:

      {
        "tool_name": "subscribe_market_data",
        "arguments": {
          "symbol": "BTCUSDT",
          "type": "spot",
          "streams": ["trade", "ticker"]
        }
      }

    客户端接收到服务器返回的 JSON-RPC 响应,其中 'content' 字段包含了工具执行的结果数据。对于 'subscribe_market_data' 工具,服务器会主动推送 WebSocket 数据更新到客户端。

请参考仓库中的 'src/index.ts' 文件和 'README.md' 文件,了解更详细的工具参数和使用方法。

信息

分类

商业系统