MCP Graphql Schema

🚀 GraphQL Schema Model Context Protocol Server

A Model Context Protocol (MCP) server that exposes GraphQL schema information to Large Language Models (LLMs) such as Claude. This server allows LLMs to explore and understand GraphQL schemas.

🚀 Quick Start

This GraphQL Schema MCP server is designed to expose schema information to LLMs, enabling them to explore and understand GraphQL schemas. You can start using it by following the installation and configuration steps below.

✨ Features

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

📦 Installation

There's no need for a separate installation process. You can directly run the server using the npx command as shown in the usage examples below.

💻 Usage Examples

Command Line

Run the MCP server and specify a particular schema file:

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

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

# Use a schema file with an absolute path
npx -y mcp-graphql-schema /absolute/path/to/schema.graphqls

# Display help information
npx -y mcp-graphql-schema --help

Claude Desktop Integration

To use this MCP server in Claude Desktop, edit the claude_desktop_config.json configuration file:

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

Configuration file locations:

• 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 in the 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 a specific schema
claude mcp add shopify-graphql-schema npx -y mcp-graphql-schema  ~/Projects/work/schema.shopify.2025-01.graphqls

2. Verify the Registered MCP Server

# List all configured servers
claude mcp list

# Get detailed information about the GraphQL schema server
claude mcp get graphql-schema

3. Remove the Server if Necessary

claude mcp remove graphql-schema

4. Use the Tool in Claude Code

After configuration, you can call the tool in a 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 (e.g., main API schema, Shopify schema).

📚 Documentation

MCP Tools

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

• list-query-fields: List all available root-level query fields.
• get-query-field: Get the detailed SDL definition of a specific query field.
• list-mutation-fields: List all available root-level mutation fields.
• get-mutation-field: Get the detailed SDL definition of a specific mutation field.
• list-subscription-fields: List all available root-level subscription fields (if subscriptions are in the schema).
• get-subscription-field: Get detailed information about a specific subscription field (if subscriptions are in the schema).
• list-types: List all types defined in the GraphQL schema (excluding internal types).
• get-type: Get the detailed SDL definition of a specific GraphQL type.
• get-type-fields: Get a simplified list of fields and their types for a specific GraphQL object type.
• search-schema: Search for types and fields using pattern matching.

Example Query

# Query example:
# List all available root-level query fields
mcp query --tool list-query-fields

With the above tools and techniques, you can effectively interact with and explore the GraphQL schema.