使用说明
项目简介
BSC MCP Server 是一个基于 Model Context Protocol (MCP) 框架构建的后端服务,旨在作为 LLM 客户端的扩展,提供与币安智能链 (Binance Smart Chain, BSC) 交互的能力。该服务器通过 MCP 协议与客户端通信,提供了一系列工具,使 LLM 应用能够安全、便捷地执行 BSC 链上的操作,例如 BNB 和 BEP-20 代币转账、在 PancakeSwap 上进行交易、调用智能合约以及创建新的代币等。
主要功能点
- BNB 和 BEP-20 代币转账: 支持原生 BNB 以及 BEP-20 标准代币的转账功能。
- PancakeSwap 交易: 集成 PancakeSwap 协议,支持在 BSC 链上进行代币兑换。
- 智能合约交互: 允许调用和执行 BSC 链上智能合约的函数。
- 钱包余额查询: 提供查询指定钱包地址 BNB 及 BEP-20 代币余额的功能。
- BEP-20 代币创建: 支持创建新的 BEP-20 标准代币。
- Meme 代币创建: 集成 Four.Meme 平台,支持快速创建 Meme 代币。
安装步骤
-
克隆仓库
git clone https://github.com/TermiX-official/bsc-mcp.git -
进入项目目录
cd bsc-mcp -
安装依赖 使用 npm 或 yarn 安装项目依赖:
npm install或
yarn install -
配置环境变量 在项目根目录下创建 '.env' 文件,并根据需要配置以下环境变量:
WALLET_PRIVATE_KEY=你的BSC钱包私钥 # 必须:用于交易签名,请务必安全保管 BSC_RPC_URL=https://bsc-dataseed.binance.org # 可选:BSC RPC URL,默认为 Binance 官方数据源 MORALIS_API_KEY=你的Moralis API Key # 可选:Moralis API Key,用于获取更详细的代币余额信息,如需使用余额查询功能,建议配置请务必妥善保管你的 'WALLET_PRIVATE_KEY',避免泄露。
-
构建项目 执行构建命令,生成可运行的 JavaScript 代码:
npm run build
服务器配置
要将 BSC MCP Server 集成到 MCP 客户端(如 Claude Desktop),您需要在客户端的配置文件中添加服务器配置信息。以下是一个配置示例,请根据您的实际情况修改文件路径:
{ "serverName": "bsc-mcp", // 服务器名称,在客户端中用于标识和引用 "command": "node", // 启动服务器的命令,这里使用 Node.js 运行 JavaScript "args": [ // 启动命令的参数列表 "/path/to/bsc-mcp/build/index.js" // 服务器入口文件路径,请替换为实际的 index.js 文件路径,例如 "/Users/Username/bsc-mcp/build/index.js" ], "env": { // 传递给服务器进程的环境变量 "BSC_WALLET_PRIVATE_KEY": "BSC_WALLET_PRIVATE_KEY", // 私钥环境变量名,与 .env 文件中配置的变量名一致 "BSC_RPC_URL": "BSC_RPC_URL", // BSC RPC URL 环境变量名 "MORALIS_API_KEY": "MORALIS_API_KEY" // Moralis API Key 环境变量名 (可选) } }
注意:
- 请将 '"args"' 中的文件路径 '/path/to/bsc-mcp/build/index.js' 替换为 'bsc-mcp' 项目构建后 'index.js' 文件的实际路径。
- '"serverName"' 可以自定义,客户端将使用此名称来引用该服务器。
- '"env"' 中定义了服务器运行时需要的环境变量,确保与您在 '.env' 文件中配置的环境变量名一致。
基本使用方法
-
启动服务器 在项目根目录下,执行以下命令启动 BSC MCP Server:
npm start或直接运行构建后的 'index.js' 文件:
node build/index.js服务器默认通过 Stdio 传输协议与客户端通信。
-
客户端调用工具 启动服务器后,您可以在 MCP 客户端中使用 BSC MCP Server 提供的工具。工具列表及其参数请参考仓库的 'README.md' 文件或源代码中 'src/tools' 目录下的工具定义文件。客户端将通过 MCP 协议与服务器进行 JSON-RPC 通信,调用注册的工具来执行 BSC 链上的相关操作。
例如,要使用 'transferBEP20Token' 工具转账 BEP-20 代币,您需要在客户端构建符合 MCP 协议的 JSON-RPC 请求,指定工具名称为 'transferBEP20Token',并提供必要的参数(如接收地址、转账数量、代币符号或地址等)。服务器将处理请求,执行代币转账操作,并将结果返回给客户端。
信息
分类
网页与API