README
🚀 BNBChain MCP
BNBChain MCP是一个全面的模型上下文协议(MCP)服务器,用于与币安智能链(BSC)进行交互,为代币转移、去中心化交易所(DEX)操作和智能合约交互提供安全高效的工具。
🚀 快速开始
BNBChain MCP是一个可用于生产环境的MCP服务器,它使AI代理和应用程序能够与币安智能链生态系统进行交互。以下是快速使用步骤:
1. 初始配置
运行交互式设置向导:
bnbchain-mcp --init
向导会提示你输入以下信息:
- BSC钱包私钥(必填) - 你的钱包私钥
- 钱包密码(必填) - 用于加密的密码,至少6个字符
- 自定义RPC URL(可选) - 默认使用币安公共RPC
2. 验证安装
bnbchain-mcp --version
3. 启动MCP服务器
npm start
# 或者
node build/index.js
✨ 主要特性
🔐 安全性
- 采用 AES - 256加密 存储私钥
- 使用 bcrypt密码保护 钱包凭证
- 集成 GoPlus安全服务 进行代币验证
- 安全的配置管理
💱 去中心化金融(DeFi)操作
- 集成 PancakeSwap V2/V3 进行代币交换
- 流动性管理(添加/移除头寸)
- 头寸跟踪 和资产组合管理
- 优化燃气费的交易路由
🪙 代币管理
- 原生BNB转移
- 通过符号或地址进行BEP - 20代币转移
- 支持模因代币创建和交易(Four.Meme平台)
- 代币安全分析和验证
🤖 支持AI
- 符合 模型上下文协议(MCP)
- 无缝集成Claude Desktop
- 为AI代理提供结构化工具API
- 采用类型安全的TypeScript实现
📦 安装指南
前提条件
- Node.js 18+(需要支持ESM)
- npm或yarn包管理器
全局安装
npm install -g bnbchain-mcp
本地开发
git clone <repository-url>
cd bsc-mcp
npm install
npm run build
💻 使用示例
可用工具
钱包操作
| 工具 | 描述 | 参数 |
|------|-------------|------------|
| transferNativeToken | 将BNB转移到钱包地址 | to, amount |
| transferBEP20Token | 通过符号或地址转移BEP - 20代币 | token, to, amount |
| getWalletInfo | 获取全面的钱包信息 | address |
| getBalance | 获取地址的代币和原生代币余额 | address, token(可选) |
PancakeSwap操作
| 工具 | 描述 | 参数 |
|------|-------------|------------|
| pancakeSwap | 通过PancakeSwap执行代币交换 | tokenIn, tokenOut, amount, slippage |
| pancakeAddLiquidity | 向PancakeSwap池添加流动性 | tokenA, tokenB, amountA, amountB |
| pancakeMyPosition | 查看你的PancakeSwap流动性头寸 | poolAddress(可选) |
| pancakeRemovePosition | 从PancakeSwap移除流动性 | poolAddress, liquidity |
模因代币操作
| 工具 | 描述 | 参数 |
|------|-------------|------------|
| buyMemeToken | 在Four.Meme上购买模因代币 | tokenAddress, amount |
| sellMemeToken | 在Four.Meme上出售模因代币 | tokenAddress, amount |
| queryMemeTokenDetails | 获取模因代币的详细信息 | tokenAddress |
安全与分析
| 工具 | 描述 | 参数 |
|------|-------------|------------|
| securityCheck | 对代币进行GoPlus安全分析 | tokenAddress |
📚 详细文档
Claude Desktop集成
初始配置完成后,该工具会自动配置Claude Desktop集成。 配置文件位置:
~/Library/Application Support/Claude/claude_desktop_config.json
MCP服务器将被自动检测到,并可与Claude Desktop一起使用。
合约地址
| 合约类型 | 地址 | 描述 |
|--------------|---------|-------------|
| Four.Meme尝试购买 | 0xF251F83e40a78868FcfA3FA4599Dad6494E46034 | 代币购买合约 |
| Four.Meme买卖AMAP | 0x5c952063c7fc8610FFDB798152D69F0B9550762b | 自动市场调整定价 |
| Four.Meme创建代币 | 0x5c952063c7fc8610FFDB798152D69F0B9550762b | 代币工厂合约 |
| PancakeSwap路由器V2 | 通过SDK集成 | DEX路由和交换 |
| PancakeSwap V3池 | 通过SDK访问 | 流动性池管理 |
开发
构建项目
npm run build
运行测试
# 运行所有测试
npm test
# 运行特定测试套件
npm run test:privateAES
重新配置
若要更新配置:
bnbchain-mcp --init
开发脚本
# 构建并初始化
npm run init:build
# 自动发布(维护者使用)
npm run publish:auto
架构
项目结构
bsc-mcp/
├── src/
│ ├── cli/ # CLI命令处理程序
│ ├── functions/ # 核心业务逻辑
│ ├── tools/ # MCP工具实现
│ ├── lib/ # 共享库和ABIs
│ ├── types/ # TypeScript类型定义
│ ├── config.ts # 配置管理
│ ├── main.ts # MCP服务器入口点
│ └── index.ts # CLI入口点
├── build/ # 编译后的JavaScript输出
└── scripts/ # 构建和部署脚本
安全架构
- 私钥加密:使用用户提供的密码进行AES - 256加密
- 密码哈希:使用bcrypt进行安全的密码存储
- 配置存储:加密的本地配置文件
- 代币验证:集成GoPlus SDK进行安全检查
模型上下文协议(MCP)
本项目实现了模型上下文协议,这是一个标准化协议,用于AI代理与外部工具和数据源进行交互。
MCP优势
- ✅ 结构化通信:类型安全的请求/响应模式
- ✅ AI代理兼容性:可与Claude、OpenAI和其他MCP兼容代理一起使用
- ✅ 安全架构:基于服务器的执行,使用加密凭证
- ✅ 可扩展设计:易于添加新工具和功能
配置
配置以加密格式存储在以下位置:
- macOS/Linux:
~/.bnbchain-mcp/config.json - Windows:
%USERPROFILE%\.bnbchain-mcp\config.json
环境变量
可以设置可选的环境变量:
BSC_RPC_URL:自定义RPC端点MORALIS_API_KEY:Moralis API密钥,用于增强数据访问
路线图
已完成 ✅
- [x] CLI配置向导
- [x] Claude Desktop集成
- [x] 代币部署和转移
- [x] PancakeSwap V2/V3集成
- [x] 模因代币交易支持
- [x] 安全分析工具
进行中 🚧
- [ ] 增强错误处理和重试逻辑
- [ ] 多钱包支持
- [ ] 交易历史跟踪
计划 📋
- [ ] 代币图表集成(DEXTools、CoinGecko)
- [ ] Telegram机器人集成
- [ ] 高级AI交易策略
- [ ] 跨链桥支持
贡献
我们欢迎贡献!请遵循以下指南:
- 分叉仓库 并创建功能分支
- 遵循TypeScript最佳实践 并保持类型安全
- 为新功能添加测试
- 根据需要更新文档
- 提交拉取请求 并提供清晰的描述
开发设置
# 克隆并安装
git clone <repository-url>
cd bsc-mcp
npm install
# 进行更改并测试
npm run build
npm test
# 提交PR
安全注意事项
⚠️ 重要提示
- 切勿分享你的私钥 或钱包密码
- 使用强密码(至少6个字符,建议更长)
- 确保配置文件安全 且切勿将其提交到版本控制
- 执行交易前验证代币地址
- 大额交易前先小额测试
- 交易未知代币前查看安全检查结果
故障排除
常见问题
问题:MCP服务器无法连接
- 解决方案:使用
bnbchain-mcp --init验证配置
问题:交易失败
- 解决方案:检查BNB余额以支付燃气费,并验证RPC端点
问题:Claude Desktop未检测到服务器
- 解决方案:确保配置文件路径正确,并重启Claude Desktop
📄 许可证
本项目采用MIT许可证 - 详情请参阅LICENSE文件。
支持
如有问题、疑问或想要做出贡献:
- 在GitHub上创建问题
- 查看现有文档
- 查看故障排除部分
致谢
- 基于模型上下文协议SDK构建
- 由Viem和PancakeSwap SDK提供支持
- 安全分析由GoPlus提供
为下一代Web3 AI代理而构建 🤖⚡
微信扫一扫