MCP Graphql Schema

🚀 GraphQL 模式模型上下文協議服務器

本項目是一個基於 Model Context Protocol (MCP) 的服務器，它能將 GraphQL 模式信息暴露給大型語言模型（LLMs），如 Claude。藉助該服務器，LLM 可以對 GraphQL 模式進行探索與理解。

✨ 主要特性

• 靈活加載模式：可通過命令行參數指定並加載任意 GraphQL 模式文件。
• 多類型字段探索：支持探索查詢、突變和訂閱字段。
• 詳細類型查看：能夠查看詳細的類型定義。
• 模式匹配搜索：可使用模式匹配搜索類型和字段。
• 簡化信息獲取：獲取簡化的字段信息，包含類型和參數。
• 結果清潔過濾：過濾掉內部 GraphQL 類型，使結果更簡潔。

📦 安裝指南

此部分未提及具體安裝步驟，跳過。

💻 使用示例

命令行

運行 MCP 服務器並指定特定的模式文件：

# 使用當前目錄中的默認schema.graphqls
npx -y mcp-graphql-schema

# 使用相對路徑的特定模式文件
npx -y mcp-graphql-schema ../schema.shopify.2025-01.graphqls

# 使用絕對路徑的模式文件
npx -y mcp-graphql-schema /absolute/path/to/schema.graphqls

# 顯示幫助信息
npx -y mcp-graphql-schema --help

Claude Desktop 集成

要在 Claude Desktop 中使用此 MCP 服務器，請編輯 claude_desktop_config.json 配置文件：

{
  "mcpServers": {
    "GraphQL Schema": {
      "command": "npx",
      "args": ["-y", "mcp-graphql-schema", "/ABSOLUTE/PATH/TO/schema.graphqls"]
    }
  }
}

配置文件位置：

• macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: $env:AppData\Claude\claude_desktop_config.json

Claude Code 集成

要在 Claude Code CLI 中使用此 MCP 服務器，請按照以下步驟操作：

1. 將 GraphQL 模式 MCP 服務器添加到 Claude Code

# 基本語法
claude mcp add graphql-schema npx -y mcp-graphql-schema

# 示例帶有特定模式的
claude mcp add shopify-graphql-schema npx -y mcp-graphql-schema  ~/Projects/work/schema.shopify.2025-01.graphqls

2. 驗證註冊的 MCP 服務器

# 列出所有配置好的服務器
claude mcp list

# 獲取 GraphQL 模式服務器的詳細信息
claude mcp get graphql-schema

3. 如果需要可以刪除服務器

claude mcp remove graphql-schema

4. 在 Claude Code 中使用工具 配置完成後，您可以在 Claude Code 會話中通過詢問關於 GraphQL 模式的問題來調用該工具。

技巧：

• 使用 -s 或 --scope 標誌與 project（默認）或 global 指定配置存儲的位置。
• 為不同的模式添加多個 MCP 服務器（例如主要 API 模式、Shopify 模式）。

📚 詳細文檔

MCP 工具

該服務器為 LLM 提供了以下工具來與 GraphQL 模式交互：

• list-query-fields：列出所有可用的根級別查詢字段。
• get-query-field：獲取特定查詢字段的詳細 SDL 定義。
• list-mutation-fields：列出所有可用的根級別突變字段。
• get-mutation-field：獲取特定突變字段的詳細 SDL 定義。
• list-subscription-fields：列出所有可用的根級別訂閱字段（如果模式中有訂閱）。
• get-subscription-field：獲取特定訂閱字段的詳細信息（如果模式中有訂閱）。
• list-types：列出 GraphQL 模式中定義的所有類型（排除內部類型）。
• get-type：獲取特定 GraphQL 類型的詳細 SDL 定義。
• get-type-fields：獲取特定 GraphQL 對象類型的簡化字段列表及其類型。
• search-schema：使用模式匹配搜索類型和字段。

示例查詢

# 查詢示例：
# 列出所有可用的根級別查詢字段
mcp query --tool list-query-fields

通過以上工具和技術，您可以有效地在 GraphQL 模式中進行交互和探索。