项目简介
Bybit MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型 (LLM) 客户端提供访问 Bybit 加密货币交易所 API 的能力。通过此服务器,LLM 可以获取实时的市场数据、订单簿、K线数据、交易历史以及用户的账户信息(需配置API密钥),从而增强 LLM 在加密货币领域的应用能力。
请务必注意: 该项目目前处于 Alpha 阶段,存在潜在风险。强烈建议仅使用只读 API 密钥,切勿使用包含交易权限的 API 密钥,以确保您的资产安全。
主要功能点
- 提供丰富的 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': 获取已认证用户的订单历史记录
- 基于 MCP 协议标准: 遵循 MCP 协议,易于与各种 MCP 客户端集成。
- 支持多种交易品类: 涵盖现货、永续合约(线性和反向)等多种交易品类的数据访问。
- 包含交互式客户端: 提供一个命令行客户端,方便用户与服务器进行交互和测试。
安装步骤
- 安装 Node.js 和 pnpm: 确保您的系统已安装 Node.js (v20+) 和 pnpm 包管理器 ('npm i -g pnpm')。
- 克隆仓库: 将仓库 'https://github.com/sammcj/bybit-mcp' 克隆到本地。
- 安装依赖: 在仓库根目录下运行 'pnpm i' 命令安装项目依赖。
服务器配置
MCP 客户端需要配置 MCP 服务器的启动命令才能连接。以下是配置示例,请根据您的 MCP 客户端进行相应配置。
MCP 服务器名称: 'bybit' (可自定义)
启动命令 (command): '/path/to/bybit-mcp/build/index.js'
- 注意: 请将 '/path/to/bybit-mcp/build/index.js' 替换为实际的服务器代码路径。
命令参数 (args): '[]' (通常无需额外参数)
环境变量 (env): (以下为必须配置的环境变量,请根据实际情况填写)
{ "BYBIT_API_KEY": "您的 Bybit 只读 API 密钥", "BYBIT_API_SECRET": "您的 Bybit 只读 API 密钥Secret", "BYBIT_USE_TESTNET": "false" // 可选,设置为 "true" 以使用测试网,默认为 "false" }
- BYBIT_API_KEY: 您的 Bybit API 密钥 (必须,务必使用只读密钥)
- BYBIT_API_SECRET: 您的 Bybit API 密钥 Secret (必须,务必使用只读密钥)
- BYBIT_USE_TESTNET: 是否使用 Bybit 测试网络 (可选,默认为 'false',即使用主网)
MCP 客户端配置示例 (JSON 格式):
{ "mcpServers": { "bybit": { "command": "node", "args": ["/path/to/bybit-mcp/build/index.js"], "env": { "BYBIT_API_KEY": "your-api-key", "BYBIT_API_SECRET": "your-api-secret", "BYBIT_USE_TESTNET": "false" } } } }
基本使用方法
-
启动 MCP 服务器: 在仓库根目录下运行 'pnpm serve' 命令启动 MCP 服务器。
-
配置 MCP 客户端: 根据您的 MCP 客户端 (如 Claude Desktop, gomcp) 的配置方法,添加上述服务器配置信息。
-
在 LLM 中使用工具: 在支持 MCP 协议的 LLM 应用中,即可通过自然语言指令调用 Bybit MCP Server 提供的工具,例如:
- 询问 "BTCUSDT 现货价格是多少?" LLM 可能会调用 'get_ticker' 工具并返回结果。
- 询问 "查看 BTCUSDT 的订单簿。" LLM 可能会调用 'get_orderbook' 工具并返回订单簿数据。
请参考仓库的 README.md 文件和工具文档了解更详细的使用方法和工具参数。
信息
分类
商业系统