使用说明

项目简介

Avalanche MCP Tools 是一个 MCP 服务器实现，它将 Avalanche 命令行工具 (CLI) 和 AvalancheJS SDK 的功能封装成一系列可被 AI 客户端调用的工具 (Tools)。通过这个服务器，用户可以使用支持 MCP 协议的 AI 助手，以自然语言的方式与 Avalanche 区块链进行交互，完成例如查询区块链信息、发布区块链等操作。

主要功能点

区块链管理:
- 列出已创建的 Avalanche 区块链配置 ('blockchainList')
- 发布区块链的虚拟机到仓库 ('blockchainPublish')
未来功能 (Coming Soon):
- 子网管理 (Subnet creation and management, Subnet deployment and monitoring, Validator operations)
- 密钥管理 (Key generation and storage, Address management, Signing operations)
- 交易操作 (Transaction building and signing, Transaction submission and monitoring, Gas optimization)

安装步骤

克隆仓库:

git clone https://github.com/utkucy/avalanche-mcp-tools.git
cd avalanche-mcp-tools

安装依赖: 确保已安装 Node.js 16+ 和 npm。在项目根目录下运行：
```
npm install
```
构建项目:
```
npm run build
```
安装 Avalanche CLI (如果尚未安装): 请参考 Avalanche 官方文档安装 Avalanche CLI 并确保 'avalanche' 命令在您的 PATH 环境变量中可用。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Avalanche MCP 服务器。

{
  "serverName": "avalanche-mcp-tools",
  "command": "npm",
  "args": ["start"],
  "transport": "stdio"
}

配置参数说明:

'serverName': 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。例如: '"avalanche-mcp-tools"'。
'command': 启动服务器的命令。由于项目使用 npm 管理，并且 'package.json' 中定义了 'start' 脚本，因此这里设置为 '"npm"'。
'args': 启动命令的参数。'npm start' 命令会执行 'package.json' 中定义的 'start' 脚本，启动 MCP 服务器。因此参数设置为 '["start"]'。
'transport': MCP 服务器使用的传输协议。本项目使用标准输入输出 (stdio) 作为传输协议，因此设置为 '"stdio"'。

注意:

确保您的环境中已安装 Avalanche CLI 并且可以正常运行 'avalanche' 命令。
确保您的 Avalanche 节点连接配置正确 (本地或远程)。

基本使用方法

启动 MCP 服务器: 在项目根目录下运行：
```
npm start
```
服务器将通过 stdio 启动并等待 MCP 客户端的连接和请求。
配置 MCP 客户端: 将上述提供的服务器配置 JSON 信息添加到您的 MCP 客户端配置中。

通过 MCP 客户端与 Avalanche 交互: 使用支持 MCP 协议的 AI 助手 (如 Claude) 或 MCP 客户端，即可通过自然语言指令调用 Avalanche MCP 服务器提供的工具。例如，在 AI 助手中输入 "List all my avalanche blockchains" (列出我所有的 Avalanche 区块链)，AI 助手将调用 'blockchainList' 工具并返回结果。

示例对话:

用户: List all my avalanche blockchains
AI助手: 正在查询 Avalanche 区块链列表...
[调用 blockchainList MCP 工具]
AI助手: 以下是您的 Avalanche 区块链列表:
- mySubnet (已部署)
- testChain
- devNet

关键词