🚀 以太坊模型上下文协议（EVMCP）服务器
本项目的以太坊模型上下文协议（EVMCP）服务器，能让外部系统或应用程序通过多样的工具接口，与以太坊区块链进行交互，为开发者提供便捷的区块链交互方案。
🚀 快速开始
环境要求
- 操作系统：支持 Linux 或 macOS（推荐）
- Node.js 版本：16.0.0 或更高
- pnpm 版本：4.0.0 或更高
- 以太坊 RPC 节点：需要一个可用的以太坊 JSON - RPC 端点（如 Infura、Alchemy 等）
安装与运行
1. 克隆仓库
git clone https://github.com/your-repository/evm-mcp-server.git
cd evm-mcp-server
2. 安装依赖
pnpm install
3. 创建环境变量文件
复制 .env.example 文件并命名为 .env，然后根据需要修改配置：
cp .env.example .env
编辑 .env 文件并填写以下内容：
WALLET_PRIVATE_KEY=your-wallet-private-key
RPC_PROVIDER_URL=https://eth-mainnet.alchemyapi.io/v2/your-api-key
DEFAULT_GAS_LIMIT=100000
DEFAULT_GAS_PRICE=200000
4. 编译代码
pnpm run build
5. 启动服务器
pnpm run start
✨ 主要特性
- 提供一个可靠且易用的以太坊区块链交互界面。
- 实现多种以太坊相关操作工具，支持地址管理、代币操作等功能。
- 提供详细的文档和示例代码，便于开发者集成和使用。
📦 项目结构
evm-mcp-server/
├── src/ # 核心服务代码
│ ├── evm.ts # 主服务器入口逻辑
│ └── evm-tools.ts # 所有 MCP 工具的定义和实现
├── test/ # 测试代码
│ └── client.ts # 示例测试客户端
├── build/ # 编译生成的 JavaScript 代码（由 `pnpm run build` 自动生成）
├── .env.example # 环境变量示例文件
├── .env # 环境变量配置文件（需自行创建，且不会被版本控制）
├── .gitignore # 忽略文件列表
├── package.json # 项目依赖和脚本
├── pnpm-lock.yaml # pnpm 文件
├── tsconfig.json # TypeScript 编译器配置
├── README.md # 英文版本说明
└── README.zh.md # 中文版本说明
💻 使用示例
开发环境准备
pnpm run dev
测试代码
pnpm test
调试日志
pnpm run debug
📚 详细文档
可用工具
以下是当前服务器支持的所有工具及其描述：
| 工具名称 | 描述 |
|---|---|
getAddress |
获取与服务器连接的钱包地址。 |
getChain |
获取服务器连接的链 ID 和链名。 |
getBalance |
获取指定地址（或服务器钱包）的原生代币余额。 |
signTransaction |
对交易进行签名，准备发送到区块链。 |
sendTransaction |
发送已签名的交易到区块链并返回交易哈希。 |
deployContract |
部署新智能合约到区块链。 |
callContract |
调用已部署在区块链上的智能合约方法。 |
transferEth |
向指定地址发送以太坊原生代币（ETH）。 |
approveToken |
授权服务器钱包管理某个代币的转账操作。 |
文档引用
- 以太坊黄皮书：https://ethereum.org/en/whitepaper/
- JSON - RPC 标准：https://www.jsonrpc.org/specification
- Solidity 编程语言：https://soliditylang.org/
贡献指南
欢迎社区贡献！请参考 CONTRIBUTING.md 了解如何为本项目贡献力量。
项目现状
- 版本：v1.0.0
- 维护状态：积极维护中
- 更新日志：请查看 CHANGELOG.md
🔧 技术细节
本项目基于以太坊网络构建了模型上下文协议（EVMCP）服务器。通过暴露多种工具接口，使得外部系统或应用程序能够与以太坊区块链进行交互。服务器的核心服务代码位于 src 目录下，其中 evm.ts 是主服务器入口逻辑，evm-tools.ts 定义和实现了所有 MCP 工具。测试代码在 test 目录下，通过 pnpm test 可以运行测试。
📄 许可证
文档中未提及相关内容，暂不展示。
⚠️ 重要提示
- 私钥管理：请确保
.env文件中的WALLET_PRIVATE_KEY不被泄露或提交到版本控制系统。 - RPC 安全：使用 HTTPS 确保与 RPC 提供商的通信安全，并定期更新 API 密钥。
- 权限控制：根据实际需求，限制对服务器端点的访问权限。