graphql-lsp

GraphQL Analyzer

A fast, Rust-powered GraphQL tooling suite with IDE support, CLI validation, and AI agent integration.

GraphQL Analyzer provides real-time validation, navigation, and linting for GraphQL projects. It works with pure .graphql files and embedded GraphQL in TypeScript/JavaScript, Vue, Svelte, and Astro components, with full support for multi-project workspaces and remote schema introspection.

Under the hood, the analyzer uses a query-based architecture with incremental computation via Salsa. This means only the parts of your project affected by a change are recomputed, keeping the IDE responsive even in large codebases.

This project draws heavy inspiration from rust-analyzer for its architecture, and builds on the patterns established by graphql-language-service and graphql-config from the GraphQL community.

Quick Start

1. Install the VS Code Extension

Install GraphQL Analyzer from the VS Code Marketplace, or search "GraphQL Analyzer" in the Extensions view.

2. Configure Your Project

Create a config file in your project root (.graphqlrc.yml, .graphqlrc.toml, or .graphqlrc.json):

# .graphqlrc.yml
schema: "schema.graphql"
documents: "src/**/*.{graphql,ts,tsx,vue,svelte,astro}"

3. Start Coding

Open any GraphQL file, TypeScript/JavaScript file, or Vue/Svelte/Astro component with embedded GraphQL. You'll get:

• Real-time validation - Instant feedback on errors
• Go to definition - Jump to types, fragments, and fields
• Find references - See all usages across your project
• Hover information - Type details and descriptions

CLI Usage

Install the CLI for CI/CD integration:

# Homebrew (macOS/Linux)
brew install trevor-scheer/graphql-analyzer/graphql-analyzer

# Or via install script
curl -fsSL https://raw.githubusercontent.com/trevor-scheer/graphql-analyzer/main/scripts/install.sh | sh

Validate your GraphQL:

graphql validate
graphql lint

Use --format json or --format github for CI integration.

For full CLI documentation, see the CLI README.

GitHub Action

For GitHub-native CI with inline PR annotations, SARIF, and an optional summary comment:

- uses: actions/checkout@v4
- uses: trevor-scheer/graphql-analyzer-action@v1

See the GitHub Action docs and the action repo.

Configuration

schema: "schema.graphql"
documents: "src/**/*.{graphql,ts,tsx,vue,svelte,astro}"

extensions:
  lint:
    extends: recommended
    rules:
      noDeprecated: warn

Resolved Schema

If your build pipeline transforms schemas (e.g., directive-based transforms), queries can be validated against the build output instead of the source SDL:

extensions:
  graphql-analyzer:
    resolvedSchema: "generated/schema.graphql"

When configured, query validation and completions use the resolved schema while goto-definition and hover prefer source files (falling back to the resolved schema for generated fields).

For multi-project setups and advanced configuration, see the Configuration Guide.

Documentation

Component	Description
VS Code Extension	IDE features, installation, troubleshooting
CLI	Commands, CI/CD integration, output formats
LSP Server	Editor integration, Neovim setup, debugging
MCP Server	AI agent integration for Claude and others
Claude Code Plugin	GraphQL LSP plugin for Claude Code
Development Guide	Building from source, testing, contributing

License

MIT OR Apache-2.0