使用说明
项目简介
BSC Explorer MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型(LLM)应用提供访问币安智能链(BSC)区块链数据的能力。通过此服务器,LLM 可以查询 BSC 网络的区块信息、交易详情、账户余额,甚至可以创建 Meme Token。它充当 LLM 和 BSC 之间的桥梁,使得 LLM 应用能够利用区块链的实时数据和交易功能。
主要功能点
- 获取 BSC 网络数据: 提供多种工具,允许 LLM 查询最新的区块高度、区块详细信息、交易信息和交易回执。
- 账户余额查询: 支持查询指定钱包地址的 BNB 余额以及 BEP-20 Token 的余额。
- Meme Token 创建: 允许用户通过简单的参数配置,在 BSC 网络上创建自定义的 Meme Token (Four.meme)。
- 多种通信协议支持: 支持 STDIO 和 HTTP/SSE 两种传输协议,方便集成到不同的 LLM 客户端。
- 易于配置和部署: 通过环境变量进行配置,安装和运行步骤简单明了。
安装步骤
- 安装 Node.js: 确保你的系统中安装了 Node.js (v16 或更高版本) 和 npm 或 yarn 包管理器。
- 克隆仓库 (如果使用 Git):
git clone https://github.com/ArcReactor9/BSC_MCP_SERVICES cd BSC_MCP_SERVICES - 安装依赖: 在项目根目录下运行以下命令安装项目依赖:
npm install - 构建项目: 运行以下命令编译 TypeScript 代码到 JavaScript:
npm run build
服务器配置
MCP 客户端配置 (以 JSON 格式)
为了让 MCP 客户端连接到 BSC Explorer MCP Server,你需要提供服务器的启动配置信息。以下是分别针对 STDIO 和 HTTP/SSE 服务器的配置示例。
1. STDIO 服务器配置
适用于通过标准输入输出流 (STDIO) 与服务器通信的 MCP 客户端。
{ "serverName": "BSC Explorer STDIO", "command": "node", "args": ["dist/index.js"] }
- 'serverName': 服务器的名称,可以自定义,用于在客户端中标识服务器。
- 'command': 启动服务器的命令,这里是 'node',表示使用 Node.js 运行时环境。
- 'args': 启动命令的参数,'["dist/index.js"]' 指定了服务器入口文件为 'dist/index.js'。
2. HTTP/SSE 服务器配置
适用于通过 HTTP Server-Sent Events (SSE) 与服务器通信的 MCP 客户端。
{ "serverName": "BSC Explorer HTTP/SSE", "command": "node", "args": ["dist/server-http.js"], "baseUrl": "http://localhost:3000" }
- 'serverName': 服务器的名称,可以自定义。
- 'command': 启动服务器的命令,同样是 'node'。
- 'args': 启动命令的参数,'["dist/server-http.js"]' 指定 HTTP/SSE 服务器的入口文件。
- 'baseUrl': HTTP 服务器的基础 URL,默认为 'http://localhost:3000'。如果服务器运行在不同的端口或主机上,需要相应修改。可以通过设置环境变量 'PORT' 来自定义端口,例如 'PORT=8080 node dist/server-http.js'。
环境变量配置 (可选)
- 'BSC_RPC_URL': 用于指定 BSC 网络的 RPC URL。默认连接到 BSC 主网 ('https://bsc-dataseed.binance.org/')。如果需要连接到测试网或其他 BSC 节点,可以设置此环境变量,例如 'BSC_RPC_URL=https://data-seed-prebsc-1-s1.binance.org:8545/' (BSC 测试网)。
- 'BSC_PRIVATE_KEY': 用于创建 Meme Token 功能的私钥。如果需要使用 'create-four-meme-token' 工具,必须设置此环境变量为你的 BSC 钱包私钥。请务必妥善保管私钥,避免泄露!
设置环境变量的方法 (示例)
- Windows (命令提示符): 'set BSC_RPC_URL=你的BSC_RPC_URL'
- Linux/macOS (终端): 'export BSC_RPC_URL=你的BSC_RPC_URL'
基本使用方法
-
启动服务器:
- STDIO 服务器: 在项目根目录下运行 'node dist/index.js'
- HTTP/SSE 服务器: 在项目根目录下运行 'node dist/server-http.js'
-
配置 MCP 客户端: 根据你选择的服务器类型(STDIO 或 HTTP/SSE),将上面提供的 JSON 配置信息填入你的 MCP 客户端中。确保客户端能够正确连接到服务器。
-
调用工具 (Tools): 客户端连接成功后,即可调用服务器提供的工具。以下是一些工具及其使用示例 (工具名称和参数需要与 MCP 客户端的界面或 API 相匹配):
- 'get-block-number': 获取当前 BSC 区块高度,无需参数。
- 'get-block': 获取区块详细信息,参数 'blockHashOrNumber' 可以是区块哈希 (字符串) 或区块号 (数字)。例如: '{"blockHashOrNumber": 1000000}' 或 '{"blockHashOrNumber": "0x..."}'
- 'get-transaction': 获取交易详细信息,参数 'txHash' 为交易哈希 (字符串)。例如: '{"txHash": "0x..."}'
- 'get-balance': 获取账户 BNB 余额,参数 'address' 为钱包地址 (字符串)。例如: '{"address": "0x..."}'
- 'get-token-balance': 获取 BEP-20 Token 余额,参数 'tokenAddress' 为 Token 合约地址 (字符串),'walletAddress' 为钱包地址 (字符串)。例如: '{"tokenAddress": "0x...", "walletAddress": "0x..."}'
- 'create-four-meme-token': 创建 Meme Token,需要以下参数:
- 'name': Token 名称 (字符串)
- 'symbol': Token 符号 (字符串)
- 'initialSupply': 初始发行量 (数字)
- 'decimals': Token 小数位数 (数字,默认为 18)
- 'ownerAddress': Token 所有者地址 (字符串) 例如:
注意: 创建 Token 需要配置 'BSC_PRIVATE_KEY' 环境变量,并消耗 BSC 网络 Gas 费用。{ "name": "My Meme Token", "symbol": "MMT", "initialSupply": 1000000, "decimals": 18, "ownerAddress": "0xYourWalletAddress" }
-
查看结果: 工具调用结果将以文本形式返回给 MCP 客户端,客户端可以根据结果内容进行展示或进一步处理。
注意事项
- 安全性: 如果使用 'create-four-meme-token' 功能,请务必谨慎处理 'BSC_PRIVATE_KEY',避免泄露。建议仅在测试环境中使用此功能。
- 网络连接: 确保服务器能够正常连接到 BSC 网络。检查 'BSC_RPC_URL' 配置是否正确。
- 依赖安装: 在运行服务器之前,务必完成依赖安装和项目构建步骤。
信息
分类
开发者工具