Hedera Dev Mirrornode MCP Server

🚀 測試網鏡像節點 MCP 服務器（Hedera）

本項目提供了一個與 Hedera Testnet Mirror Node API 接口交互的 Model Context Protocol (MCP) 服務器。它藉助 FastMCP 這一 TypeScript 框架來創建 MCP 服務器，並利用 Zod 方案進行輸入驗證，為開發者提供了便捷且可靠的服務。

✨ 主要特性

• 端點集成：可自動把 Hedera Mirror Node 的 APIs（以 OpenAPI 規範格式定義）轉換為與 MCP 兼容的工具。
• 服務器發送事件 (SSE) 支持：客戶端無法通過此 MCP 服務器使用 SSE 運輸連接。
• 模式驗證：運用 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

📚 詳細文檔

項目結構

• 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：用於構建 MCP 服務器的框架。
• Zod：用於 TypeScript 先行方案聲明和驗證的庫。
• openapi-zod-client：從 OpenAPI 規範文件生成 Zodios 代碼。

📄 許可證

本項目採用 MIT 許可證。

👨‍💻 作者

Brendan Graetz