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