使用说明

项目简介

BSCMCP Server 是一个 Model Context Protocol (MCP) 服务器,它为 AI 应用程序(如 Claude Desktop 和 Cursor)提供了一系列强大的链上工具,使其能够与 BNB Chain 和 Binance API 进行交互。通过 BSCMCP Server,AI 应用可以轻松访问和操作 BNB Chain 上的数据和功能,例如查询钱包信息、进行交易、部署合约以及与 DeFi 协议互动等。

主要功能点

  • 钱包管理工具: 获取钱包地址、查询钱包余额、进行资金转账。
  • 智能合约交互: 部署智能合约、调用合约功能。
  • DeFi 功能: 查询借贷协议 (Morpho) 的金库信息。
  • 法币入金: 通过 Binance Onramp 服务进行法币到加密货币的兑换。
  • BEP20 Token 支持: 查询和转移 BEP20 代币。
  • OpenRouter Credits 购买: 使用 BUSD 购买 OpenRouter API 的额度。

安装步骤

BSCMCP Server 提供了两种安装方式:

方式一:从 npm 安装 (推荐)

  1. 打开终端,运行以下命令全局安装 'bsc-mcp':
    npm install -g bsc-mcp
    或者在你的项目目录下本地安装:
    npm install bsc-mcp

方式二:从源码安装

  1. 克隆 GitHub 仓库到本地:
    git clone https://github.com/bscmcp-labs/mcp.git
    cd mcp
  2. 安装项目依赖:
    npm install
  3. 构建项目:
    npm run build
  4. (可选)全局链接,方便在任何地方运行:
    npm link

服务器配置

要将 BSCMCP Server 集成到 MCP 客户端(例如 Claude Desktop),您需要配置客户端的 MCP 服务器设置。以下是针对 Claude Desktop 的配置示例,其他 MCP 客户端的配置方式类似。

  1. 打开或创建 Claude Desktop 的配置文件 'claude_desktop_config.json',文件路径如下:

    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
    • Linux: '~/.config/Claude/claude_desktop_config.json'
  2. 在配置文件中添加或修改 'mcpServers' 字段,添加 'bsc-mcp' 服务器的配置信息。请注意替换以下配置中的占位符为您实际的路径和凭据。

    {
      "mcpServers": {
        "bsc-mcp": { // 服务器名称,可以自定义
          "command": "node", // 启动服务器的命令,这里使用 Node.js 运行
          "args": ["/path/to/bsc-mcp/build/index.js"], // 启动参数,指向 BSCMCP Server 构建后的入口文件 index.js。**请将 "/path/to/bsc-mcp" 替换为 BSCMCP Server 的实际安装路径。**
          "env": { // 环境变量配置,用于服务器运行所需的 API 密钥、种子短语等敏感信息
            "BINANCE_API_KEY_NAME": "your_api_key_name", // 你的 Binance API Key Name,从 Binance 开发者平台获取
            "BINANCE_API_PRIVATE_KEY": "your_private_key", // 你的 Binance API Private Key,从 Binance 开发者平台获取
            "SEED_PHRASE": "your seed phrase here", // 你的钱包种子短语 (12 或 24 个单词),用于签名交易
            "BINANCE_PROJECT_ID": "your_project_id", // 你的 Binance Project ID,用于 Onramp 功能,从 Binance 开发者平台获取
            "OPENROUTER_API_KEY": "your_openrouter_api_key" // (可选)你的 OpenRouter API Key,用于购买 OpenRouter Credits,从 https://openrouter.ai/keys 获取
          },
          "disabled": false, // 设置为 false 启用该服务器
          "autoApprove": [] // 自动批准的工具列表,留空表示需要手动批准
        }
      }
    }

    重要提示:

    • 请务必将 '/path/to/bsc-mcp/build/index.js' 替换为 BSCMCP Server 实际的安装路径。如果您是全局安装的 'bsc-mcp',可能需要找到全局 npm 包的安装路径,或者使用 'which bsc-mcp' (Linux/macOS) 或 'where bsc-mcp' (Windows) 查找 'bsc-mcp' 命令的路径,然后根据相对路径调整 'args'。
    • 敏感信息(如 API 密钥和种子短语)通过环境变量配置,请确保 '.env' 文件或环境变量设置的安全性,避免泄露。
  3. 重启 Claude Desktop 或其他 MCP 客户端,配置即可生效。

基本使用方法

配置完成后,您可以在 Claude Desktop 或其他 MCP 客户端中,通过自然语言指令调用 BSCMCP Server 提供的工具。例如:

  • 在 Claude 中提问 "What's my wallet address?" 客户端会调用 'get-address' 工具,返回您的钱包地址。
  • 提问 "Show me my wallet balances." 客户端会调用 'list-balances' 工具,列出您的钱包余额。
  • 提问 "Transfer 0.01 BNB to 0x1234567890abcdef1234567890abcdef12345678." 客户端会调用 'transfer-funds' 工具,向指定地址转账 0.01 BNB (需要您手动批准交易)。

更多工具的使用方法和示例,请参考仓库中的 'examples.md' 文件和 "Available Tools" 章节。

信息

分类

商业系统