GraphQL Schema Documentation Builder

Generates interactive API documentation from GraphQL schemas using graphql-js introspection queries and SpectaQL. Produces type relationship diagrams, query examples, and deprecation notices from SDL files.

Overview

The GraphQL Schema Documentation Builder skill transforms GraphQL Schema Definition Language files into comprehensive API documentation. It uses graphql-js introspection queries to extract the full type system including objects, interfaces, unions, enums, and input types with their field-level descriptions.

The skill integrates with SpectaQL for static documentation site generation and graphql-voyager for interactive schema visualization. It parses SDL files to detect @deprecated directives and generates migration guides for deprecated fields with suggested alternatives.

Key features include automatic query and mutation example generation with realistic fake data using faker.js, subscription documentation with WebSocket connection details, custom scalar documentation extraction, and relay-style pagination pattern detection. The skill also validates schemas against best practices including the Shopify GraphQL Design Tutorial guidelines and generates TypeScript type definitions using graphql-codegen for client SDK documentation.

Installation

Any Agent

npx skills add agentskillexchange/skills --skill graphql-schema-documentation-builder

Claude Code

npx skills add agentskillexchange/skills --skill graphql-schema-documentation-builder -a claude-code

Cursor

npx skills add agentskillexchange/skills --skill graphql-schema-documentation-builder -a cursor

Codex

npx skills add agentskillexchange/skills --skill graphql-schema-documentation-builder -a codex

OpenClaw

clawhub install graphql-schema-documentation-builder

Source

• Marketplace: https://agentskillexchange.com/skills/graphql-schema-documentation-builder/