MCP Graphql Forge

🚀 mcp-graphql-forge

mcp-graphql-forge 是一個輕量級、基於配置的MCP服務器，它能將經過篩選的GraphQL查詢作為模塊化工具公開，助力您的代理進行有意圖的API交互，為您打造更便捷、高效的API交互體驗。

🚀 快速開始

mcp-graphql-forge 能讓您把任意GraphQL端點轉變為MCP服務器，其工具由YAML文件定義，這些文件明確了GraphQL查詢及其參數。藉助這種方式，您無需修改應用程序代碼，就能創建出一個模塊化、安全且易於擴展的服務器。

✨ 主要特性

• 輕量級：不會給系統帶來過多負擔，運行高效。
• 基於配置：通過YAML文件和環境變量進行靈活配置，無需修改應用程序代碼。
• 模塊化：工具以模塊化形式存在，便於管理和擴展。
• 安全：可對API交互進行有效管控，保障數據安全。

📦 安裝指南

文檔未提及安裝步驟，暫不提供相關內容。

📚 詳細文檔

配置

服務器藉助環境變量和YAML文件進行配置。

環境變量

• FORGE_CONFIG：指定包含YAML配置文件（forge.yaml和工具定義）的文件夾路徑。若未設置，默認為當前目錄（.）。
• FORGE_DEBUG：若設置為true（不區分大小寫），則會啟用詳細的調試日誌記錄到stderr，內容涵蓋獲得的令牌以及GraphQL調用的完整HTTP請求/響應。默認值為false。

forge.yaml

配置文件夾採用特殊的配置文件forge.yaml，其中明確了通用配置屬性。

文件中可指定以下屬性：

• name：MCP服務器的名稱
• version：MCP服務器的版本
• url：GraphQL端點的URL
• token_command：用於請求Authorization頭的Bearer令牌的命令（可選）

以下是一個示例配置：

name: "ExampleServer"
version: "0.1.0"
url: "https://api.github.com/graphql"
token_command: "gh auth token"

工具配置

文件夾裡的其他所有YAML文件都被視作配置文件，每個YAML文件定義一個MCP服務器的工具。

文件中可指定以下屬性：

• name：MCP工具的名稱
• description：MCP工具的描述
• query：要執行的GraphQL查詢
• inputs：定義輸入並傳遞給GraphQL查詢作為變量的MCP工具的輸入列表
  • name：輸入的名稱
  • type：參數類型；可以是string或number
  • description：MCP工具使用的參數描述
  • required：布爾值，指定屬性是否為必需

以下是一個示例配置：

name: "getUser"
description: "通過`login`獲取用戶的基本信息，包括他們的名稱、URL和位置。"
query: |
  query ($login: String!) {
    user(login: $login) {
      id
      name
      url
      location
    }
  }
inputs:
  - name: "login"
    type: "string"
    description: "唯一標識其帳戶的`login`。"
    required: true

🔧 技術細節

侷限性

• 每個mcp-graphql-forge實例僅能與單個GraphQL服務器在單個URL上使用。
• 所有請求都採用相同的Authorization頭，形式為Bearer令牌。
• GraphQL查詢全部作為工具公開，而非資源。這是因為當前並非所有MCP客戶端都支持資源。