@bnb-chain/mcp-server
v0.0.1
Published
A MCP server for BNB Chain that supports BSC, opBNB, Greenfield, and other popular EVM-compatible networks.
Readme
BNBChain MCP (Model Context Protocol)
A powerful toolkit for interacting with BNB Chain and other EVM-compatible networks through natural language processing and AI assistance.
Description
BNBChain MCP is a Model Context Protocol implementation that enables seamless interaction with blockchain networks through AI-powered interfaces. It provides a comprehensive set of tools and resources for blockchain development, smart contract interaction, and network management.
Core Modules
The project is organized into several core modules:
- Blocks: Query and manage blockchain blocks
- Contracts: Interact with smart contracts
- Network: Network information and management
- NFT: NFT (ERC721/ERC1155) operations
- Tokens: Token (ERC20) operations
- Transactions: Transaction management
- Wallet: Wallet operations and management
- Common: Shared utilities and types
How to Use in Cursor
To connect to the MCP server from Cursor:
- Open Cursor and go to Settings (gear icon in the top right)
- Click on "MCP" in the left sidebar
- Click "Add new global MCP server"
- Enter the following details:
Default mode
{
"mcpServers": {
"bnbchain-mcp-server": {
"command": "npx",
"args": ["-y", "@bnb-chain/mcp-server"]
}
}
}SSE mode
{
"mcpServers": {
"bnbchain-mcp-server": {
"command": "npx",
"args": ["-y", "@bnb-chain/mcp-server", "--sse"]
}
}
}Development
Prerequisites
- bun 1.2.10 or higher
# Install dependencies
bun install
# Start the development server
bun devSupported Tools and Resources
| Name | Description |
| ------------------------------------------------------------------ | ----------------------------------------------------- |
| get_chain_info | Get information about an EVM network |
| get_supported_networks | Get a list of supported EVM networks |
| get_transaction | Get detailed information about a specific transaction |
| get_transaction_receipt | Get a transaction receipt by its hash |
| estimate_gas | Estimate the gas cost for a transaction |
| transfer_eth | Transfer native tokens (ETH, BNB, etc.) to an address |
| transfer_token | Transfer ERC20 tokens to another address |
| approve_token_spending | Approve another address to spend your ERC20 tokens |
| transfer_nft | Transfer an NFT (ERC721 token) to another address |
| transfer_erc1155 | Transfer ERC1155 tokens to another address |
| check_nft_ownership | Check if an address owns a specific NFT |
| get_nft_info | Get detailed information about a specific NFT |
| get_address_from_private_key | Get the EVM address derived from a private key |
| resolve_ens | Resolve an ENS name to an EVM address |
| is_contract | Check if an address is a smart contract or EOA |
Supported Networks
Supports BSC, opBNB, Ethereum, and other major EVM-compatible networks. For more details, see src/evm/chains.ts.
Testing
We use the @modelcontextprotocol/inspector tool for testing. Run the following command to open a UI interface for inspection:
bun run testContributing
We welcome contributions to BNBChain MCP! Here's how you can help:
- Fork the repository
- Create a feature branch
- Commit your changes
- Push to your branch
- Create a Pull Request
Please ensure your code follows our coding standards and includes appropriate tests.
License
This project is licensed under the MIT License - see the LICENSE file for details.
