bnbchain-mcp

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

BNB Chain MCP Skill

BNB Chain MCP 技能

How to connect to the BNB Chain MCP server and use its tools: blocks, transactions, contracts, tokens, NFTs, wallet, ERC-8004 agents, and Greenfield. Use this skill when working with BNB Chain / opBNB / EVM or Greenfield via MCP.

本指南介绍如何连接BNB Chain MCP服务器并使用其工具:区块、交易、合约、代币、NFT、钱包、ERC-8004 Agent和Greenfield相关功能。当你需要通过MCP使用BNB Chain / opBNB / EVM或Greenfield服务时可参考本指南。

Connection and credentials

连接与凭证

  • Run the server:
    npx @bnb-chain/mcp@latest
    (fetches from npm at runtime). Source: github.com/bnb-chain/bnbchain-mcp.
  • RPC: Default chains use built-in RPC; no config unless self-hosting or custom RPC.
  • PRIVATE_KEY: Omit or leave empty for read-only (blocks, balances, contract reads). Set in the MCP server
    env
    for state-changing tools (transfers,
    write_contract
    ,
    approve_token_spending
    , ERC-8004 register/set_uri, Greenfield writes). Never log or expose private keys.
  • Read-only vs state-changing: Block/balance/contract-read tools work without a key; transfers and writes require
    PRIVATE_KEY
    in the server environment.

  • 运行服务器:
    npx @bnb-chain/mcp@latest
    (运行时从npm拉取包)。源码地址:github.com/bnb-chain/bnbchain-mcp
  • RPC: 默认链使用内置RPC,除非是自托管或自定义RPC,否则无需额外配置。
  • PRIVATE_KEY: 如果仅使用只读功能(查询区块、余额、合约读操作)可省略或留空。如果需要使用修改链上状态的工具(转账、
    write_contract
    approve_token_spending
    、ERC-8004注册/设置URI、Greenfield写操作),请在MCP服务器的
    env
    中配置。切勿记录或暴露私钥。
  • 只读 vs 状态修改: 区块/余额/合约读工具无需私钥即可使用;转账和写操作需要在服务器环境中配置
    PRIVATE_KEY

1. MCP server config

1. MCP服务器配置

Add the
bnbchain-mcp
server to the MCP client config (e.g. Cursor MCP settings, Claude Desktop
claude_desktop_config.json
).
Default (stdio):
json
{
  "mcpServers": {
    "bnbchain-mcp": {
      "command": "npx",
      "args": ["-y", "@bnb-chain/mcp@latest"],
      "env": {
        "PRIVATE_KEY": ""
      }
    }
  }
}
SSE mode:
"args": ["-y", "@bnb-chain/mcp@latest", "--sse"]
(and client SSE URL if required). Local dev server (e.g.
bun dev:sse
in bnbchain-mcp):
"url": "http://localhost:3001/sse"
with the same
env
.
Restart or reload the MCP client after changing config so the server starts.

bnbchain-mcp
服务器添加到MCP客户端配置中(例如Cursor MCP设置、Claude Desktop的
claude_desktop_config.json
文件)。
默认(stdio模式):
json
{
  "mcpServers": {
    "bnbchain-mcp": {
      "command": "npx",
      "args": ["-y", "@bnb-chain/mcp@latest"],
      "env": {
        "PRIVATE_KEY": ""
      }
    }
  }
}
SSE模式:
"args": ["-y", "@bnb-chain/mcp@latest", "--sse"]
(如果需要还需配置客户端SSE URL)。本地开发服务器(例如在bnbchain-mcp项目中运行
bun dev:sse
):配置
"url": "http://localhost:3001/sse"
并使用相同的
env
配置。
修改配置后需要重启或重载MCP客户端,服务器才会启动。

2. Credentials and environment

2. 凭证与环境配置

  • RPC: Built-in for default chains.
  • PRIVATE_KEY: Set in the server’s
    env
    when state-changing tools are needed; leave empty for read-only. Do not commit or echo keys.

  • RPC: 默认链已内置RPC配置。
  • PRIVATE_KEY: 需要使用状态修改工具时在服务器的
    env
    中配置,只读场景留空即可。不要提交或打印私钥。

3. Agent registration (ERC-8004)

3. Agent注册(ERC-8004)

  1. Register the agent on-chain with the MCP tool
    register_erc8004_agent
    (see references/erc8004-tools-reference.md).
  2. Owners can then check registration on 8004scan (mainnet) or 8004scan (testnet).

  1. 使用MCP工具
    register_erc8004_agent
    将Agent注册到链上(参考references/erc8004-tools-reference.md)。
  2. 注册完成后,所有者可以在主网或测试网的8004scan上查询注册状态。

4. Quick reference — tools and prompts

4. 快速参考:工具与提示词

Network parameter

网络参数

Most EVM tools accept
network
(optional): chain name or ID, e.g.
bsc
,
opbnb
,
ethereum
,
base
. Default is
bsc
. Use
get_supported_networks
to list supported networks.
大部分EVM工具都支持可选的
network
参数:可以传链名称或链ID,例如
bsc
opbnb
ethereum
base
,默认值为
bsc
。可以使用
get_supported_networks
工具查询所有支持的网络。

Tool categories

工具分类

CategoryExamplesNeeds PRIVATE_KEY?
Blocks
get_latest_block
,
get_block_by_number
,
get_block_by_hash
No
Transactions
get_transaction
,
get_transaction_receipt
,
estimate_gas
No (estimate only)
Network
get_chain_info
,
get_supported_networks
No
Wallet / balance
get_native_balance
,
get_erc20_balance
,
get_address_from_private_key
Balance: optional address or privateKey
Transfers / writes
transfer_native_token
,
transfer_erc20
,
transfer_nft
,
transfer_erc1155
,
approve_token_spending
,
write_contract
Yes
Contracts
read_contract
,
is_contract
No for read
Tokens / NFT
get_erc20_token_info
,
get_nft_info
,
get_erc1155_token_metadata
,
check_nft_ownership
,
get_nft_balance
,
get_erc1155_balance
No for read
ERC-8004
register_erc8004_agent
,
set_erc8004_agent_uri
,
get_erc8004_agent
,
get_erc8004_agent_wallet
Register/set_uri: Yes
Greenfield
gnfd_*
bucket/object/payment tools
Writes: Yes
分类示例工具是否需要PRIVATE_KEY?
区块
get_latest_block
,
get_block_by_number
,
get_block_by_hash
不需要
交易
get_transaction
,
get_transaction_receipt
,
estimate_gas
不需要(仅估算gas时)
网络
get_chain_info
,
get_supported_networks
不需要
钱包/余额
get_native_balance
,
get_erc20_balance
,
get_address_from_private_key
余额查询:可选传入地址或私钥
转账/写操作
transfer_native_token
,
transfer_erc20
,
transfer_nft
,
transfer_erc1155
,
approve_token_spending
,
write_contract
需要
合约
read_contract
,
is_contract
读操作不需要
代币/NFT
get_erc20_token_info
,
get_nft_info
,
get_erc1155_token_metadata
,
check_nft_ownership
,
get_nft_balance
,
get_erc1155_balance
读操作不需要
ERC-8004
register_erc8004_agent
,
set_erc8004_agent_uri
,
get_erc8004_agent
,
get_erc8004_agent_wallet
注册/设置URI需要
Greenfield
gnfd_*
开头的存储桶/对象/支付工具
写操作需要

Prompts (MCP prompts)

提示词(MCP提示词)

Use the MCP prompt names when the user wants analysis or guidance:
  • analyze_block — Analyze a block and its contents
  • analyze_transaction — Analyze a specific transaction
  • analyze_address — Analyze an EVM address
  • interact_with_contract — Guidance on interacting with a smart contract
  • explain_evm_concept — Explain an EVM concept
  • compare_networks — Compare EVM-compatible networks
  • analyze_token — Analyze an ERC20 or NFT token
  • how_to_register_mcp_as_erc8004_agent — Guidance on registering MCP as ERC-8004 agent

当用户需要分析或指导时,可以使用对应的MCP提示词名称:
  • analyze_block — 分析某个区块及其内容
  • analyze_transaction — 分析指定交易
  • analyze_address — 分析某个EVM地址
  • interact_with_contract — 提供与智能合约交互的指导
  • explain_evm_concept — 解释EVM相关概念
  • compare_networks — 对比EVM兼容网络
  • analyze_token — 分析ERC20或NFT代币
  • how_to_register_mcp_as_erc8004_agent — 提供将MCP注册为ERC-8004 Agent的指导

5. Reference files (per-tool usage)

5. 参考文件(各工具的使用说明)

For parameter names, examples, and detailed usage of each tool, use:
ReferenceContent
references/evm-tools-reference.mdBlocks, transactions, network, wallet, contracts, tokens, NFT — all EVM tools
references/erc8004-tools-reference.mdregister_erc8004_agent, set_erc8004_agent_uri, get_erc8004_agent, get_erc8004_agent_wallet
references/greenfield-tools-reference.mdBuckets, objects, folders, payment accounts — all Greenfield tools
references/prompts-reference.mdAll MCP prompts and when to use them

如果需要查看每个工具的参数名称、示例和详细使用方法,可以参考以下文件:
参考文件内容
references/evm-tools-reference.md区块、交易、网络、钱包、合约、代币、NFT——所有EVM相关工具
references/erc8004-tools-reference.mdregister_erc8004_agent、set_erc8004_agent_uri、get_erc8004_agent、get_erc8004_agent_wallet相关说明
references/greenfield-tools-reference.md存储桶、对象、文件夹、支付账户——所有Greenfield相关工具
references/prompts-reference.md所有MCP提示词及适用场景

6. Safety and best practices

6. 安全与最佳实践

  1. Confirm before sending transactions: For
    transfer_*
    ,
    write_contract
    , or
    approve_token_spending
    , confirm recipient, amount, and network before calling the tool.
  2. Prefer testnet when the network is unspecified for writes or agent registration.
  3. Private keys: Only in MCP server
    env
    ; never in chat or logs.
  4. ERC-8004 agentURI: JSON metadata per the Agent Metadata Profile (name, description, image, services e.g. MCP endpoint).

  1. 发送交易前确认: 调用
    transfer_*
    write_contract
    approve_token_spending
    类工具前,请确认接收方地址、金额和网络是否正确。
  2. 写操作或Agent注册未指定网络时优先使用测试网。
  3. 私钥仅配置在MCP服务器的
    env
    中,切勿在聊天内容或日志中暴露。
  4. ERC-8004 agentURI: 需符合Agent元数据规范的JSON格式(包含名称、描述、图片、服务信息如MCP端点)。

Documentation links

文档链接