Raphtory GraphQL Schema Explorer

🚀 Raphtory GraphQL Schema Explorer 中文文檔

該 Python 模塊搭建了一個 FastMCP 服務器，藉助一組 HTTP 資源，將 Raphtory 圖表的 GraphQL 模式信息公開出來。它讓大語言模型（LLM）能夠探索並理解圖表的結構，涵蓋節點屬性和關係類型等方面。

🚀 快速開始

本模塊可助力大語言模型探索 Raphtory 圖表的結構，通過 HTTP 資源公開圖表的 GraphQL 模式信息。使用前需確保運行中的 Raphtory GraphQL 服務器已啟動。

✨ 主要特性

1. 圖表模式查詢

• 可查詢特定圖表名稱的模式。
• 能獲取節點屬性的詳細信息。
• 可獲取唯一的關係類型及其元數據。
• 支持可選包含屬性變體。

2. 資源

schema://database

返回數據庫的完整 GraphQL 模式，具體包含：

• 所有可用類型。
• 每個類型的字段。
• 字段描述。
• 參數及其默認值。

schema://graph_exists/{graph_name}

通過檢查節點的存在，驗證特定圖表是否存在於數據庫中。

schema://{graph_name}/{include_variants}

返回特定圖表的詳細模式信息：

• 節點屬性：
  • 屬性鍵。
  • 屬性類型（例如："Str"）。
  • 可選屬性變體。
• 關係：
  • 唯一關係類型（例如："edge_type_1"、"edge_type_2"、"edge_type_3"）。

3. 實現細節

該模塊採用了以下技術和方法：

• 依賴運行中的 Raphtory GraphQL 服務器（需提前啟動）。
• 運用 httpx 進行異步 HTTP 請求，支持 HTTP/2。
• 藉助 FastMCP 管理資源。
• 採用全局異步客戶端實現持久連接。
• 利用上下文管理確保資源正確清理。

💻 使用示例

基礎用法

查詢圖表模式：

{
  graph(path: "your_graph_name") {
    schema {
      nodes {
        properties {
          key
          propertyType
        }
      }
    }
    edges {
      list {
        properties {
          keys
          values {
            value
          }
        }
      }
    }
  }
}

響應格式

模式響應包含如下值：

{
  "data": {
    "graph": {
      "schema": {
        "nodes": [{
          "properties": [
            {"key": "name", "propertyType": "Str"},
            {"key": "type", "propertyType": "Str"}
            // ... 其他屬性
          ]
        }]
      },
      "relationships": [
        "edge_type_1",
        "edge_type_2",
        "edge_type_3"
      ]
    }
  }
}

🔧 技術細節

該模塊使用運行中的 Raphtory GraphQL 服務器，藉助 httpx 進行異步 HTTP 請求，支持 HTTP/2 協議。通過 FastMCP 管理資源，採用全局異步客戶端實現持久連接，並利用上下文管理確保資源正確清理。這些技術的運用使得模塊在性能和資源管理方面表現出色，能夠高效地公開 Raphtory 圖表的 GraphQL 模式信息。

📦 安裝指南

依賴項

• FastMCP
• httpx
• Python 3.x
• 運行中的 Raphtory GraphQL 端點（默認：http://localhost:1736/）

配置

該模塊使用默認配置：

• HTTP/2 啟用
• 10 秒超時
• Content-Type: application/json

還可以通過環境變量添加其他配置，例如身份驗證。

📚 詳細文檔

錯誤處理

該模塊包含以下錯誤處理機制：

• 處理不存在的圖表情況。
• 處理無效查詢問題。
• 處理連接問題。
• 處理響應格式錯誤。