Mirrornode Mcp Server

🚀 测试网镜像节点 MCP 服务器

本项目仓库中存有一个与 Hedera Testnet Mirror Node API 接口的 Model Context Protocol (MCP) 服务器。该服务器借助 FastMCP 这一用于创建 MCP 服务器的 TypeScript 框架构建而成，同时利用 Zod 架构开展输入验证工作。

🚀 快速开始

在运行服务器之前，请确保安装了以下内容：

• Bun 或任何其他能够直接运行 TypeScript 的环境。

安装步骤如下： (1) 克隆仓库

git clone https://github.com/hedera-dev/mirrornode-mcp-server

(2) 切换到项目目录

cd mirrornode-mcp-server

(3) 安装依赖项

npm install

要启动 MCP 服务器：

bun mcpServer.ts

成功启动后，您应该会看到：

MCP 服务器已启动

该服务器将通过配置的 SSE 端点访问。 http://localhost:3333/hedera-testnet-mirror-node-api/sse

✨ 主要特性

• 端点集成：自动将 Hedera Mirror Node API（以 OpenAPI 规范格式定义）转换为与 MCP 兼容的工具。
• 服务器发送事件 (SSE) 支持：客户端无法通过此 MCP 服务器使用 SSE 连接。
• 模式验证：确保请求参数符合定义的架构，使用 Zod。

📦 安装指南

(1) 克隆仓库

git clone https://github.com/hedera-dev/mirrornode-mcp-server

(2) 切换到项目目录

cd mirrornode-mcp-server

(3) 安装依赖项

npm install

💻 使用示例

基础用法

要启动 MCP 服务器，执行以下命令：

bun mcpServer.ts

成功启动后，您应该会看到：

MCP 服务器已启动

该服务器将通过配置的 SSE 端点访问。 http://localhost:3333/hedera-testnet-mirror-node-api/sse

📚 详细文档

项目结构

• mcpServer.ts：入口文件，初始化并启动 MCP 服务器。
• openApiZod.ts：包含 Mirror Node API 端点定义和使用 zodios（类似于 axios 增强版本）的 API 客户端。
  • 注意，此文件是通过 openapi-zod-client 自动生成，并进行了一些手动修改。

工作原理

(1) API 客户端创建 使用 createApiClient 函数为 Hedera Testnet Mirror Node 创建一个 API 客户端。MCP 服务器在该 HTTP API 客户端和其自身的 SSE 运输之间代理。

(2) 端点转换： 从 endpointDefinitions 处理每个端点定义，使用 convertZodiosToMcp 函数进行处理：

• 验证端点是否使用 GET 方法。
• 将参数映射到 Zod 架构。
• 定义一个执行函数以进行相应的 API 调用并返回结果。
• 在 MCP 服务器上注册工具。

(3) 服务器初始化： 使用 SSE 运输启动 MCP 服务器。

🔧 技术细节

本项目使用 FastMCP 这一 TypeScript 框架来创建 MCP 服务器，并利用 Zod 架构进行输入验证。在项目运行时，首先会为 Hedera Testnet Mirror Node 创建 API 客户端，MCP 服务器在该 HTTP API 客户端和其自身的 SSE 运输之间代理。接着，从 endpointDefinitions 处理每个端点定义，使用 convertZodiosToMcp 函数将其转换为 MCP 兼容的工具，包括验证端点方法、映射参数到 Zod 架构、定义执行函数并在 MCP 服务器上注册工具。最后，使用 SSE 运输启动 MCP 服务器。

📄 许可证

本项目采用 MIT 许可证。

作者

Brendan Graetz