GraphQL Schema Model Context Protocol Server

GraphQL Schema Model Context Protocol Server

site icon
2025.03.13 26
JavaScriptGraphQL 模式探索开发工具LLM 集成开发效率数据库
mcp-graphql-schema 是一个 Model Context Protocol (MCP) 服务器,专门用于向大型语言模型(如 Claude)暴露 GraphQL 模式信息。该服务器允许 LLM 通过一组专用工具探索和理解 GraphQL 模式。 核心功能包括加载任何 GraphQL 模式文件、探索查询、变更和订阅字段、查找详细的类型定义、使用模式匹配搜索类型和字段、获取简化的字段信息(包括类型和参数)以及过滤掉内部 GraphQL 类型以获得更清晰的结果。 适用场景包括开发人员需要快速了解 GraphQL 模式的结构、查询可用字段和类型、查找特定字段或类型的详细信息以及搜索与特定关键字相关的模式元素。
View on GitHub

Overview

基本能力

产品定位

mcp-graphql-schema 是一个专门用于向大型语言模型(如 Claude)暴露 GraphQL 模式信息的 MCP 服务器。

核心功能

  • 加载任何通过命令行参数指定的 GraphQL 模式文件
  • 探索查询、变更和订阅字段
  • 查找详细的类型定义
  • 使用模式匹配搜索类型和字段
  • 获取简化的字段信息,包括类型和参数
  • 过滤掉内部 GraphQL 类型以获得更清晰的结果

适用场景

  • 开发人员需要快速了解 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: 通过名称模式(不区分大小写的正则表达式)搜索模式中的类型或字段

常见问题解答

无明确常见问题解答部分。

使用教程

使用依赖

无明确前置依赖说明。

安装教程

运行 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 Schema MCP 服务器添加到 Claude Code

```bash # 基本语法 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 ```

  1. 验证 MCP 服务器是否已注册

```bash # 列出所有配置的服务器 claude mcp list

# 获取 GraphQL 模式服务器的详细信息 claude mcp get graphql-schema ```

  1. 如果需要,移除服务器

bash claude mcp remove graphql-schema

  1. 在 Claude Code 中使用该工具

配置完成后,您可以通过询问有关 GraphQL 模式的问题在 Claude Code 会话中调用该工具。

提示:

  • 使用 -s--scope 标志与 project(默认)或 global 一起指定配置存储位置
  • 为不同的模式(例如主 API 模式、Shopify 模式)添加多个具有不同名称的 MCP 服务器

调试方式

无明确调试步骤说明。

许可证

None