GraphQL Schema

Expone información del esquema GraphQL a los LLMs, permitiéndoles explorar y comprender el esquema mediante herramientas especializadas.

Documentación

GraphQL Schema Model Context Protocol Server

smithery badge Un servidor del Model Context Protocol (MCP) que expone información del esquema GraphQL a Modelos de Lenguaje Grande (LLMs) como Claude. Este servidor permite a un LLM explorar y comprender esquemas GraphQL a través de un conjunto de herramientas especializadas.

Características

  • Cargar cualquier archivo de esquema GraphQL especificado mediante argumento de línea de comandos
  • Explorar campos de consultas (query), mutaciones (mutation) y suscripciones (subscription)
  • Consultar definiciones detalladas de tipos
  • Buscar tipos y campos mediante coincidencia de patrones
  • Obtener información simplificada de campos, incluidos tipos y argumentos
  • Filtrar tipos internos de GraphQL para obtener resultados más limpios

Uso

Línea de comandos

Ejecute el servidor MCP con un archivo de esquema específico:

# 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

Instalación mediante Smithery

Para instalar GraphQL Schema para Claude Desktop automáticamente mediante Smithery:

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

Integración con Claude Desktop

Para usar este servidor MCP con Claude Desktop, edite su archivo de configuración claude_desktop_config.json:

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

Ubicación del archivo de configuración:

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

Integración con Claude Code

Para usar este servidor MCP con la CLI de Claude Code, siga estos pasos:

  1. Agregue el servidor MCP GraphQL Schema a 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. Verifique que el servidor MCP esté registrado

    # List all configured servers
    claude mcp list
    
    # Get details for your GraphQL schema server
    claude mcp get graphql-schema
    
  3. Elimine el servidor si es necesario

    claude mcp remove graphql-schema
    
  4. Use la herramienta en Claude Code

    Una vez configurado, puede invocar la herramienta en su sesión de Claude Code haciendo preguntas sobre el esquema GraphQL.

Consejos:

  • Use la bandera -s o --scope con project (predeterminado) o global para especificar dónde se almacena la configuración
  • Agregue múltiples servidores MCP para diferentes esquemas con diferentes nombres (p. ej., esquema principal de API, esquema de Shopify)

Herramientas MCP

El servidor proporciona las siguientes herramientas para que los LLMs interactúen con esquemas GraphQL:

  • list-query-fields: Enumera todos los campos disponibles de nivel raíz para consultas GraphQL
  • get-query-field: Obtiene la definición detallada de un campo de consulta específico en formato SDL
  • list-mutation-fields: Enumera todos los campos disponibles de nivel raíz para mutaciones GraphQL
  • get-mutation-field: Obtiene la definición detallada de un campo de mutación específico en formato SDL
  • list-subscription-fields: Enumera todos los campos disponibles de nivel raíz para suscripciones GraphQL (si están presentes en el esquema)
  • get-subscription-field: Obtiene la definición detallada de un campo de suscripción específico (si está presente en el esquema)
  • list-types: Enumera todos los tipos definidos en el esquema GraphQL (excluyendo tipos internos)
  • get-type: Obtiene la definición detallada de un tipo GraphQL específico en formato SDL
  • get-type-fields: Obtiene una lista simplificada de campos con sus tipos para un tipo de objeto GraphQL específico
  • search-schema: Busca tipos o campos en el esquema por patrón de nombre (regex sin distinción de mayúsculas y minúsculas)

Ejemplos

Consultas de ejemplo para probar:

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".