🚀 以太坊虚拟机（EVM） MCP 服务器文档

本项目是以太坊虚拟机（EVM） MCP 服务器，提供了对多区块链网络的支持，具备实时区块链事件监听、智能合约读写操作等丰富功能，可助力开发者高效进行区块链相关开发。

🚀 快速开始

📦 安装指南

安装步骤

1. 克隆代码库：

git clone git@github.com:your-repository.git mcp-evm-server
cd mcp-evm-server
npm install

2. 启动服务器：

npm run dev

3. 访问控制台： 启动后，可通过浏览器访问 http://localhost:5000，也可以在终端中使用 curl 命令进行访问。

配置说明

编辑 src/server/http-server.ts 文件以调整以下配置：

• PORT：服务器端口，默认为 5000
• NETWORKS：支持的区块链网络，如 Ethereum、Polygon 等
• RPC_ENDPOINTS：第三方 RPC 提供商的 URL
• WALLET_PROVIDERS：钱包提供者的配置

✨ 主要特性

核心组件

1. HTTP 服务器
   • 使用 Server-Sent Events (SSE) 提供实时更新。
   • 支持 RESTful API 和长轮询。
2. 区块链服务
   • 处理 EVM 相关的区块链操作。
3. 资源系统
   • 暴露区块链数据资源 URI，如链信息、区块、交易等。
4. 工具集
   • 提供区块链分析和交互工具。

核心功能特性

• 支持多区块链网络。
• 内置钱包和交易服务。
• 实时区块链事件监听。
• 智能合约读写操作。
• 代币余额查询与转账。
• NFT 和 ERC1155 代币支持。

🔧 技术细节

网络配置

type NetworkConfig = {
  chainId: number;
  name: string;
  rpcUrls: string[];
  blockExplorers?: Record<string, string>;
};

账户与交易

• 支持多种钱包提供者（如 MetaMask、WalletConnect）。
• 签名和广播交易。
• 交易收据解析。

📚 详细文档

安全注意事项

• 私钥安全：私钥仅用于交易签名，服务器不存储。
• 身份验证：生产环境建议增加额外认证机制。
• 传输加密：使用 HTTPS 部署生产环境。
• 速率限制：防止滥用攻击。
• 高价值服务：增加确认步骤。

项目结构

mcp-evm-server/
├── src/
│   ├── index.ts                # 标准输入输出服务器入口文件
│   ├── server/                 # 服务器相关文件
│   │   ├── http-server.ts      # HTTP 服务器实现，带 SSE 支持
│   │   └── server.ts           # 通用服务器设置
│   ├── core/
│   │   ├── chains.ts           # 区块链链定义与工具
│   │   ├── resources.ts        # MCP 资源实现
│   │   ├── tools.ts            # MCP 工具实现
│   │   ├── prompts.ts          # MCP 提示实现
│   │   └── services/           # 核心区块链服务
│   │       ├── index.ts        # 操作导出
│   │       ├── network.ts      # 网络配置与管理
│   │       ├── wallet.ts       # 钱包功能实现
│   │       ├── transaction.ts  # 交易处理逻辑
│   │       └── contract.ts     # 智能合约交互
├── package.json                # 项目依赖与脚本
└── README.md                   # 项目文档

开发指南

1. 开发环境
   • 使用 Node.js 和 TypeScript。
   • 安装 pnpm 或 npm 进行依赖管理。
2. 调试技巧
   • 启动开发服务器：npm run dev。
   • 程序运行时目录：src/。
3. 构建与部署
   • 生产构建：npm run build。
   • 部署到云服务（如 AWS、Azure）。
4. 贡献指南
   • 提交代码前，确保通过单元测试。
   • 遵循代码风格规范。

附录

常见问题

1. 如何添加新的区块链网络？
   • 在 chains.ts 中添加相应配置。
2. 支持哪些钱包提供者？
   • 当前支持 MetaMask、WalletConnect 等主流提供者。
3. 如何处理交易失败的情况？
   • 通过错误处理模块捕获并重试。

联系方式

• 邮件：contact@example.com
• GitHub：github.com/your-repository

📄 许可证

项目遵循 MIT 许可证，详情见 LICENSE 文件。

感谢使用以太坊虚拟机（EVM） MCP 服务器！如需更多帮助，请参考文档或联系支持团队。