GraphQL Schema

Servidor do Protocolo de Contexto de Modelo GraphQL Schema

Um servidor Model Context Protocol (MCP) que expõe informações de schema GraphQL para Modelos de Linguagem de Grande Porte (LLMs) como o Claude. Este servidor permite que um LLM explore e entenda schemas GraphQL por meio de um conjunto de ferramentas especializadas.

Recursos

• Carregar qualquer arquivo de schema GraphQL especificado via argumento de linha de comando
• Explorar campos de query, mutation e subscription
• Consultar definições detalhadas de tipos
• Pesquisar tipos e campos usando correspondência de padrões
• Obter informações simplificadas de campos, incluindo tipos e argumentos
• Filtrar tipos internos do GraphQL para resultados mais limpos

Uso

Linha de Comando

Execute o servidor MCP com um arquivo de schema 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

Instalação via Smithery

Para instalar o GraphQL Schema para o Claude Desktop automaticamente via Smithery:

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

Integração com Claude Desktop

Para usar este servidor MCP com o Claude Desktop, edite seu arquivo de configuração claude_desktop_config.json:

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

Localização do arquivo de configuração:

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

Integração com Claude Code

Para usar este servidor MCP com a CLI do Claude Code, siga estas etapas:

1. Adicione o servidor MCP GraphQL Schema ao 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 se o servidor MCP está registrado

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

3. Remova o servidor, se necessário

   claude mcp remove graphql-schema
   

4. Use a ferramenta no Claude Code

   Depois de configurado, você pode invocar a ferramenta na sua sessão do Claude Code fazendo perguntas sobre o schema GraphQL.

Dicas:

• Use a flag -s ou --scope com project (padrão) ou global para especificar onde a configuração é armazenada
• Adicione vários servidores MCP para diferentes schemas com nomes diferentes (por exemplo, schema principal da API, schema do Shopify)

Ferramentas MCP

O servidor fornece as seguintes ferramentas para que LLMs interajam com schemas GraphQL:

• list-query-fields: Lista todos os campos de nível raiz disponíveis para queries GraphQL
• get-query-field: Obtém a definição detalhada de um campo de query específico no formato SDL
• list-mutation-fields: Lista todos os campos de nível raiz disponíveis para mutations GraphQL
• get-mutation-field: Obtém a definição detalhada de um campo de mutation específico no formato SDL
• list-subscription-fields: Lista todos os campos de nível raiz disponíveis para subscriptions GraphQL (se presentes no schema)
• get-subscription-field: Obtém a definição detalhada de um campo de subscription específico (se presente no schema)
• list-types: Lista todos os tipos definidos no schema GraphQL (excluindo tipos internos)
• get-type: Obtém a definição detalhada de um tipo GraphQL específico no formato SDL
• get-type-fields: Obtém uma lista simplificada de campos com seus tipos para um tipo de objeto GraphQL específico
• search-schema: Pesquisa tipos ou campos no schema por padrão de nome (regex sem diferenciar maiúsculas de minúsculas)

Exemplos

Exemplos de consultas para experimentar:

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