使用说明

项目简介

EVM MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 AI Agent 提供与以太坊虚拟机 (EVM) 兼容的区块链网络进行交互的能力。它通过标准化的 MCP 协议,将复杂的区块链操作抽象为易于 AI Agent 理解和调用的 工具 (Tools)资源 (Resources),从而简化了 AI 应用与区块链数据的集成过程。

主要功能点

  • 多链支持: 支持包括 Ethereum, Optimism, Arbitrum, Base, Polygon 等 30 多个主流 EVM 兼容网络,覆盖主网和测试网。
  • 区块链数据访问: 提供链信息、区块数据、交易详情、地址余额(原生代币和 ERC20 代币)等资源的读取能力。
  • Token 服务: 支持 ERC20、ERC721 (NFT)、ERC1155 Token 标准,提供 Token 信息查询、余额查询、Token 转移、NFT 拥有权验证等功能。
  • 智能合约交互: 支持读取智能合约状态 (view/pure 函数) 和执行智能合约写操作 (需要私钥签名)。
  • ENS 名称解析: 所有接受以太坊地址的工具和资源都支持 ENS 名称,方便使用人类可读的地址。
  • 多种传输协议: 支持 Stdio 和 HTTP (SSE) 两种传输协议,满足不同应用场景的需求。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/mcpdotdirect/evm-mcp-server.git
    cd evm-mcp-server
  2. 安装依赖: 推荐使用 Bun 包管理器,或者使用 npm。
    # 使用 Bun
    bun install
    
    # 或者使用 npm
    npm install

服务器配置

MCP 服务器主要通过命令行参数进行配置。以下是 MCP 客户端 (如 Cursor 编辑器) 'mcp.json' 配置文件中常用的服务器配置信息,用于启动和连接 EVM MCP Server。

{
  "mcpServers": {
    "evm-mcp-stdio": {
      "command": "npx",
      "args": [
        "@mcpdotdirect/evm-mcp-server"
      ]
    },
    "evm-mcp-http": {
      "command": "npx",
      "args": [
        "@mcpdotdirect/evm-mcp-server",
        "--http"
      ]
    }
  }
}

配置参数说明:

  • server name: 'evm-mcp-stdio' 和 'evm-mcp-http' 是自定义的服务名称,用于在 MCP 客户端中标识不同的服务器配置。
  • type: 根据连接方式,MCP 客户端会自动判断连接类型 (command 或 url),无需显式配置。
  • command: 'npx' 是 Node.js 的包执行器,用于运行本地安装的 npm 包。
  • args: 启动 EVM MCP Server 的命令行参数数组。
    • '"@mcpdotdirect/evm-mcp-server"': 指定要执行的 npm 包,即 EVM MCP Server。
    • '"--http"' (仅 'evm-mcp-http' 配置): 可选参数,用于启动 HTTP 模式的服务器。不加此参数默认启动 Stdio 模式服务器。

注意:

  • 上述配置信息为 JSON 格式,应保存在 MCP 客户端 (如 Cursor 编辑器) 指定的配置文件 ('mcp.json') 中。
  • MCP 客户端会读取 'mcp.json' 文件,并根据配置信息启动和连接 MCP 服务器。
  • 用户无需修改 'command' 和 'args' 中的代码部分,只需根据需要选择 Stdio 或 HTTP 模式的服务器配置即可。

基本使用方法

  1. 启动服务器:
    • Stdio 模式 (命令行工具集成):
      bun start
      # 或者开发模式,支持自动reload
      bun dev
    • HTTP 模式 (Web 应用集成):
      bun start:http
      # 或者开发模式,支持自动reload
      bun dev:http
    • 使用 npx 快速启动 (无需安装):
      # Stdio 模式
      npx @mcpdotdirect/evm-mcp-server
      
      # HTTP 模式
      npx @mcpdotdirect/evm-mcp-server --http
  2. 连接 MCP 客户端: 使用任何 MCP 兼容的客户端连接到服务器。例如,在 Cursor 编辑器中,按照上述 服务器配置 部分,将配置信息添加到 '.cursor/mcp.json' 文件中,Cursor 将自动检测并连接到 EVM MCP Server。
  3. 通过 MCP 客户端与区块链交互: 连接成功后,即可在 MCP 客户端中使用 EVM MCP Server 提供的 工具 (Tools)资源 (Resources),例如查询地址余额、获取区块信息、进行 Token 交易等。具体工具和资源请参考仓库 README.md 中的 API Reference 部分。

信息

分类

AI与计算