使用说明

项目简介

Neo N3 MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 提供与 Neo N3 区块链交互的能力。通过此服务器，LLM 可以安全、便捷地查询区块链数据、管理数字资产、调用智能合约等，从而扩展 LLM 在去中心化应用领域的应用场景。

主要功能点

双网络支持: 同时支持 Neo N3 主网和测试网，灵活切换。
区块链数据查询: 获取区块高度、验证节点、区块和交易详情等链上信息。
账户和资产管理: 安全地创建、导入钱包，查询账户余额，进行 NEO、GAS 等资产的转移。
智能合约交互: 部署和调用 Neo N3 区块链上的智能合约。
交易监控: 跟踪交易状态，包括确认数等详细信息。
Gas 费用预估: 在执行交易前预估 Gas 费用，避免意外支出。
安全性: 注重安全设计，保护私钥安全，敏感操作需要确认。
易于部署: 支持 Docker 部署和一键安装，快速集成到 MCP 环境。

安装步骤

Docker 部署 (推荐):

确保已安装 Docker 和 Docker Compose。

克隆仓库到本地：

git clone https://github.com/R3E-Network/neo-n3-mcp.git
cd neo-n3-mcp

使用 Docker Compose 启动服务器：

docker-compose up -d

手动安装:

确保已安装 Node.js (>= 16.0) 和 npm。

克隆仓库到本地：

git clone https://github.com/R3E-Network/neo-n3-mcp.git
cd neo-n3-mcp

安装依赖：
```
npm install
```
构建项目：
```
npm run build
```
启动服务器：
```
npm start
```

服务器配置

要将 Neo N3 MCP 服务器添加到 MCP 客户端（如 Claude），您需要配置 MCP 服务器的启动命令和参数。以下是两种配置方式，选择其一添加到您的 'claude_desktop_config.json' 或 MCP 设置中：

使用 NPM (推荐快速开始):

{
  "mcpServers": {
    "neo-n3": {
      "command": "npx",
      "args": [
        "-y",
        "@r3e/neo-n3-mcp"
      ],
      "serverName": "neo-n3" // 服务器名称，可自定义
    }
  }
}

使用 Docker:

{
  "mcpServers": {
    "neo-n3": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "r3e/neo-n3-mcp"
      ],
      "serverName": "neo-n3" // 服务器名称，可自定义
    }
  }
}

环境变量配置:

服务器行为可以通过环境变量进行配置，例如：

'NEO_RPC_URL': Neo N3 RPC 节点 URL (默认: 'http://localhost:10332')
'NEO_NETWORK': 默认网络类型 ('mainnet' 或 'testnet', 默认: 'mainnet')

更多配置选项请参考仓库 README 文档。

基本使用方法

成功配置并启动 Neo N3 MCP 服务器后，您可以通过 MCP 客户端向服务器发送请求。服务器提供了一系列 工具 (Tools) 和 资源 (Resources)，您可以使用预定义的名称和参数来调用工具或访问资源。

工具调用示例 (JSON 格式):

{
  "name": "get_blockchain_info", // 工具名称
  "arguments": {
    "network": "testnet" // 可选网络参数，指定使用测试网
  }
}

资源访问示例 (URI 格式):

neo://testnet/block/12345  // 访问测试网 12345 区块高度的信息
neo://address/NXV7ZhHiyM1aHXwvUNBLNAkCwZ6wgeKyMZ/balance // 访问默认网络下指定地址的余额

请参考仓库 README 文档和 'examples' 目录下的示例，了解更多工具和资源的详细用法及参数说明。

关键词