GraphQL模式上下文协议服务器

这是一个模型上下文协议（MCP）服务器，它向大型语言模型（如Claude）公开GraphQL模式信息。该服务器允许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

通过Smithery安装

要通过Smithery自动安装适用于Claude Desktop的GraphQL模式：

npx -y @smithery/cli install @hannesj/mcp-graphql-schema --client claude

Claude Desktop集成

要将此MCP服务器与Claude Desktop一起使用，请编辑您的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集成

要将此MCP服务器与Claude Code CLI一起使用，请按照以下步骤操作：

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：列出GraphQL查询的所有可用顶级字段
• get-query-field：获取特定查询字段的详细定义（SDL格式）
• list-mutation-fields：列出GraphQL变更的所有可用顶级字段
• get-mutation-field：获取特定变更字段的详细定义（SDL格式）
• list-subscription-fields：列出GraphQL订阅的所有可用顶级字段（如果模式中有）
• get-subscription-field：获取特定订阅字段的详细定义（如果模式中有）
• list-types：列出GraphQL模式中定义的所有类型（不包括内部类型）
• get-type：获取特定GraphQL类型的详细定义（SDL格式）
• get-type-fields：获取特定GraphQL对象类型的简化字段列表及其类型
• search-schema：按名称模式（不区分大小写的正则表达式）搜索模式中的类型或字段

示例

尝试以下示例查询：

这个GraphQL模式中有哪些查询字段可用？
给我显示“用户”查询字段的详细信息。
在这个模式中我可以执行哪些变更操作？
列出此模式中定义的所有类型。
给我显示“产品”类型的定义。
列出“订单”类型的全部字段。
搜索与“客户”相关的类型和字段。