使用说明

项目简介

Bybit MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供访问 Bybit 加密货币交易所 API 的能力。它将 Bybit API 的功能封装成一系列易于 LLM 调用的 工具 (Tools)，使 LLM 能够获取实时的市场数据，例如加密货币的最新价格、订单簿深度、历史 K 线数据等等。

主要功能点

提供丰富的 Bybit API 工具: 包含 'get_ticker' (获取实时行情), 'get_orderbook' (获取订单簿), 'get_kline' (获取K线数据), 'get_market_info' (获取市场信息), 'get_trades' (获取最近交易), 'get_instrument_info' (获取交易对信息), 'get_wallet_balance' (获取钱包余额), 'get_positions' (获取持仓信息), 'get_order_history' (获取订单历史) 等工具，覆盖了 Bybit 交易所主要的市场和账户数据。
基于 MCP 协议: 采用标准的 Model Context Protocol 协议与客户端通信，易于集成到各种支持 MCP 协议的 LLM 应用中。
数据只读访问: 所有工具都提供只读访问，确保 API 密钥安全，避免意外交易操作风险。
支持测试网: 可以配置连接 Bybit 测试网络，方便开发者在模拟环境下进行测试和开发。

安装步骤

安装 Node.js 和 pnpm: 确保你的系统中已安装 Node.js (v20+) 和 pnpm 包管理器。如果未安装 pnpm，可以运行 'npm i -g pnpm' 进行安装。
克隆仓库: 将 GitHub 仓库 'MCP-Mirror/sammcj_bybit-mcp' 克隆到本地。
安装依赖: 在仓库根目录下运行 'pnpm i' 命令安装项目依赖。

配置环境变量: 复制 '.env.example' 文件为 '.env'，并根据需要填写 Bybit API 密钥 (只读密钥!) 和其他配置信息，例如是否使用测试网等。

cp .env.example .env
# 编辑 .env 文件，填入你的 API 密钥等信息
code .env

服务器配置

为了让 MCP 客户端（如 Claude Desktop, gomcp 等）连接到 Bybit MCP Server，你需要在客户端的 MCP 配置中添加服务器信息。以下是针对不同客户端的配置示例：

Claude Desktop 配置示例 ('~/Library/Application\ Support/Claude/claude_desktop_config.json')

{
  "mcpServers": {
    "bybit": {
      "command": "node",
      "args": ["/path/to/bybit-mcp/build/index.js"],
      "env": {
        "BYBIT_API_KEY": "YOUR_BYBIT_READONLY_API_KEY",  // 替换为你的 Bybit 只读 API Key
        "BYBIT_API_SECRET": "YOUR_BYBIT_READONLY_API_SECRET", // 替换为你的 Bybit 只读 API Secret
        "BYBIT_USE_TESTNET": "false" // 可选，设置为 "true" 使用测试网，默认为 "false" (主网)
      }
    }
  }
}

gomcp 配置示例 ('~/.config/gomcp/config.yaml')

mcp_servers:
  - name: "bybit"
    command: "cd /path/to/bybit-mcp && pnpm run serve"
    arguments: []
    env:
      BYBIT_API_KEY: "YOUR_BYBIT_READONLY_API_KEY"      # 替换为你的 Bybit 只读 API Key
      BYBIT_API_SECRET: "YOUR_BYBIT_READONLY_API_SECRET"   # 替换为你的 Bybit 只读 API Secret
      BYBIT_USE_TESTNET: "false"  # 可选，设置为 "true" 使用测试网，默认为 "false" (主网)
      DEBUG: "false"         # 可选: 设置为 "true" 开启调试日志

配置参数说明:

'command': 启动服务器的命令，通常为 'node'。
'args': 传递给 'command' 的参数，指定服务器入口文件路径。请根据你的实际安装路径修改 '/path/to/bybit-mcp' 部分。
'env': 环境变量配置，用于传递 Bybit API 密钥等敏感信息。
- 'BYBIT_API_KEY': 你的 Bybit 只读 API Key。 务必使用只读 API Key！
- 'BYBIT_API_SECRET': 你的 Bybit 只读 API Secret。 务必使用只读 API Secret！
- 'BYBIT_USE_TESTNET': 可选，设置为 '"true"' 使用 Bybit 测试网络，设置为 '"false"' 或不设置使用主网。
- 'DEBUG': 可选，设置为 '"true"' 开启服务器调试日志，默认为 '"false"'。

基本使用方法

启动服务器: 在仓库根目录下运行 'pnpm serve' 命令启动 Bybit MCP Server。
配置 MCP 客户端: 根据你的 MCP 客户端类型（如 Claude Desktop, gomcp），按照上述 "服务器配置" 示例配置服务器连接信息。
在 LLM 中使用工具: 在支持 MCP 协议的 LLM 应用中，你可以指示 LLM 使用 'get_ticker', 'get_orderbook' 等工具来查询 Bybit 交易所的加密货币数据。例如，你可以向 LLM 提问： "What is the current price of BTCUSDT?" (BTCUSDT 的当前价格是多少？)。LLM 应该能够识别并调用相应的工具来获取实时数据并返回给你。

关键词