GraphQL Schema

What is GraphQL Schema about?

GraphQL Schema provides a Model Context Protocol (MCP) server that lets large language models interact with any GraphQL schema. By loading a schema file, the server offers a set of tools that list and describe query, mutation, subscription fields, object types, and searchable elements, all in SDL format.

How to use GraphQL Schema?

Command‑line

# Default – looks for schema.graphqls in the current directory
npx -y mcp-graphql-schema

# Specify a schema file (relative path)
npx -y mcp-graphql-schema ../schema.shopify.2025-01.graphqls

# Specify a schema file (absolute path)
npx -y mcp-graphql-schema /absolute/path/to/schema.graphqls

Claude Desktop – add the server to claude_desktop_config.json:

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

Claude Code CLI – register the server:

claude mcp add graphql-schema npx -y mcp-graphql-schema /path/to/schema.graphqls

After registration, ask the LLM questions about the schema using the provided tools.

Key features of GraphQL Schema

• Load any GraphQL schema file via CLI argument.
• list-query-fields, list-mutation-fields, list-subscription-fields to enumerate root operations.
• get-query-field, get-mutation-field, get-subscription-field to retrieve SDL definitions.
• list-types and get-type for full type inspection, excluding internal GraphQL types.
• get-type-fields for a simplified field list with types and arguments.
• search-schema supports case‑insensitive regex pattern matching across types and fields.
• Zero‑configuration startup with npx.

Use cases of GraphQL Schema

• LLM‑assisted development: Allow Claude or other models to answer schema‑related questions, generate queries, or suggest mutations.
• Documentation generation: Automatically retrieve SDL snippets for inclusion in docs.
• Schema exploration: Interactive debugging or learning of third‑party GraphQL APIs.
• Tooling integration: Plug into IDE extensions or CI pipelines that need programmatic schema introspection.

FAQ from the GraphQL Schema

Q: Do I need to install anything globally? A: No. The server runs via npx, which downloads the package on demand.

Q: Can I run multiple schemas simultaneously? A: Yes. Register separate MCP servers with different names and schema paths.

Q: How are internal GraphQL types filtered? A: Types prefixed with __ are omitted from listings to keep output clean.

Q: Is there a way to change the default schema file name? A: Provide the path to any .graphqls file as a command‑line argument.

Q: What environments are supported? A: Any platform with Node.js and npm (Windows, macOS, Linux).

GraphQL Schema Model Context Protocol Server

A Model Context Protocol (MCP) server that exposes GraphQL schema information to Large Language Models (LLMs) like Claude. This server allows an LLM to explore and understand GraphQL schemas through a set of specialized tools.

Features

• Load any GraphQL schema file specified via command line argument
• Explore query, mutation, and subscription fields
• Look up detailed type definitions
• Search for types and fields using pattern matching
• Get simplified field information including types and arguments
• Filter out internal GraphQL types for cleaner results

Usage

Command Line

Run the MCP server with a specific schema file:

# Use the default schema.graphqls in current directory
npx -y mcp-graphql-schema

# Use a specific schema file (relative path)
npx -y mcp-graphql-schema ../schema.shopify.2025-01.graphqls

# Use a specific schema file (absolute path)
npx -y mcp-graphql-schema /absolute/path/to/schema.graphqls

# Show help
npx -y mcp-graphql-schema --help

Installing via Smithery

To install GraphQL Schema for Claude Desktop automatically via Smithery:

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

Claude Desktop Integration

To use this MCP server with Claude Desktop, edit your claude_desktop_config.json configuration file:

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

Location of the configuration file:

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

Claude Code Integration

To use this MCP server with Claude Code CLI, follow these steps:

1. Add the GraphQL Schema MCP server to Claude Code

   # Basic syntax
   claude mcp add graphql-schema npx -y mcp-graphql-schema
   
   # Example with specific schema
   claude mcp add shopify-graphql-schema npx -y mcp-graphql-schema  ~/Projects/work/schema.shopify.2025-01.graphqls
   

2. Verify the MCP server is registered

   # List all configured servers
   claude mcp list
   
   # Get details for your GraphQL schema server
   claude mcp get graphql-schema
   

3. Remove the server if needed

   claude mcp remove graphql-schema
   

4. Use the tool in Claude Code

   Once configured, you can invoke the tool in your Claude Code session by asking questions about the GraphQL schema.

Tips:

• Use the -s or --scope flag with project (default) or global to specify where the configuration is stored
• Add multiple MCP servers for different schemas with different names (e.g., main API schema, Shopify schema)

MCP Tools

The server provides the following tools for LLMs to interact with GraphQL schemas:

• list-query-fields: Lists all available root-level fields for GraphQL queries
• get-query-field: Gets detailed definition for a specific query field in SDL format
• list-mutation-fields: Lists all available root-level fields for GraphQL mutations
• get-mutation-field: Gets detailed definition for a specific mutation field in SDL format
• list-subscription-fields: Lists all available root-level fields for GraphQL subscriptions (if present in schema)
• get-subscription-field: Gets detailed definition for a specific subscription field (if present in schema)
• list-types: Lists all types defined in the GraphQL schema (excluding internal types)
• get-type: Gets detailed definition for a specific GraphQL type in SDL format
• get-type-fields: Gets a simplified list of fields with their types for a specific GraphQL object type
• search-schema: Searches for types or fields in the schema by name pattern (case-insensitive regex)

Examples

Example queries to try:

What query fields are available in this GraphQL schema?
Show me the details of the "user" query field.
What mutation operations can I perform in this schema?
List all types defined in this schema.
Show me the definition of the "Product" type.
List all fields of the "Order" type.
Search for types and fields related to "customer".