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

一个基于FastMCP框架的MCP服务器,用于与Hedera测试网镜像节点API交互,提供端点集成、服务器发送事件支持和模式验证功能。

  • by hedera-dev
  • TypeScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 hedera-dev/mirrornode-mcp-server

使用说明

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

该存储库包含一个模型上下文协议(MCP)服务器,该服务器与Hedera Testnet镜像节点API接口。 服务器是使用 FastMCP,一个用于创建MCP服务器的TypeScript框架。 它利用 萨德 用于输入验证的模式。

特性

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

先决条件

在运行服务器之前,请确保已安装以下内容:

  • 包子,或能够直接运行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 server started

服务器将可通过配置的SSE端点访问。

http://localhost:3333/hedera-testnet-mirror-node-api/sse

项目结构

  • mcpServer.ts:初始化和启动MCP服务器的入口点。
  • openApiZod.ts:包含镜像节点API终结点定义和使用的API客户端 zodios (比如 axios 增强与 zod 模式定义)。
    • 请注意,此文件是使用编程生成的 openapi-zod-client 加上一些手动修改。

运作原理

(1) API客户端创建

使用 createApiClient 功能。 MCP服务器在此HTTP API客户端与其自身的SSE传输之间进行代理。

(2) 端点转换:

每个端点定义来自 endpointDefinitions 由 convertZodiosToMcp 功能,其中:

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

(3) 服务器初始化:

MCP服务器通过SSE传输启动。

依赖项

  • FastMCP:构建MCP服务器的框架。
  • 萨德:TypeScript第一个模式声明和验证库。
  • openapi zod客户端:从OpenAPI规范文件生成Zodios代码。

作者

布伦丹·格雷茨

许可证

麻省理工学院