Validate GraphQL Schema

schema.validate_graphql_schema

ProductionEngine wrapper (Class A)Deterministicstrictmoderatev1.0.0

No network

Overview

You send GraphQL Schema Definition Language as schema text or as named virtual .graphqls files. Squillify parses it with graphql-java under explicit character, token and rule-depth limits, then builds an unexecutable type system so duplicate types and unknown references become diagnostics. This does not run queries, attach resolvers or fetch imports from the network. A successful call costs 2 execution credits.

Agents need an offline GraphQL SDL lint that cannot execute queries or fetch imports.

Reliability

GRAPHQL_SCHEMA_LIMIT_EXCEEDED — trigger: more than 2 MiB, 100 files, 50000 tokens, depth 500 or 500 diagnostics; retryable: no; next: split the schema.

Context footprint

SDL is schema text only. A successful call costs 2 execution credits.

When to use it

When the caller already holds GraphQL SDL text or a bounded set of virtual .graphqls files.

When a live GraphQL endpoint, federation composition or resolver wiring must be checked.

Scope

Note

Parses GraphQL SDL and reports type-system problems without executing the schema.

Non-goals

Does not execute queries
Does not attach resolvers or data fetchers
Does not fetch remote imports or federation supergraphs

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

parsingvalidation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call2 credits

File handling

Accepts file_refProduces file_refMax input2.1 MB

How we handle your data

Sensitive input, safe output

What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees

Runs inside Squillify
This skill runs inside Squillify.
Payloads are not sent to an external service by this skill.
Squillify does not permanently store submitted payloads.
Telemetry records metadata only, not submitted content.
Submitted payloads are not used for training.
Submitted payloads are not reviewed by humans.
This skill does not target sensitive data.
The response does not contain submitted content.

Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

Field	Type	Required	Description
schema	string	No	GraphQL SDL, 1 through 2097153 characters; runtime accepts at most 2097152. Omit it when sending files.
files	array	No	Named virtual .graphqls files, 0 through 101 closed {path, source} objects; runtime accepts at most 100. Omit it when sending schema.
allowDescriptions	boolean	No	Whether GraphQL descriptions are kept during parse; omit it for true.
maxDiagnostics	integer	No	How many diagnostics to return, 1 through 501; runtime accepts at most 500. Omit it for 500.

Output schema

Field	Type	Required	Description
valid	boolean	Yes	True when the SDL parsed and the type system contained no ERROR diagnostics.
typeCount	integer	Yes	How many named types the parser registered.
directiveCount	integer	Yes	How many directive definitions the parser registered.
diagnostics	array	Yes	Deterministically ordered closed {code, severity, message, path} diagnostics, 0 through 500 entries.
truncated	boolean	Yes	True when more diagnostics existed than maxDiagnostics allowed to list.
engine	string	Yes	Pinned graphql-java Maven coordinate used for parse and type-system construction.

API contract

POST /v1/execute

curl

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"schema.validate_graphql_schema","input":{"schema":"type Query { ping: String }"}}'

Integrations

TypeScript SDK

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("schema.validate_graphql_schema", {"schema":"type Query { ping: String }"});

Errors

Code	HTTP	Retryable	Description
VALIDATION_ERROR	400	No	The request payload failed schema validation.
UNAUTHORIZED	401	No	Missing or invalid API key.
SKILL_NOT_ACCESSIBLE	403	No	The API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN	403	No	This skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE	503	Yes	Plan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND	404	No	The requested skill or version does not exist.
TENANT_RATE_LIMITED	429	Yes	Request rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED	429	Yes	Plan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT	504	Yes	Execution exceeded the allowed time budget.
GRAPHQL_SCHEMA_LIMIT_EXCEEDED	429	No	A size, quota, rate, or time limit was exceeded.

Other limits

Limit	Value
Recommended inline bytes	32 KiB

Limitations

Does not execute queries
Does not attach resolvers or data fetchers
Does not fetch remote imports or federation supergraphs
Running GraphQL operations
Validating federation composition

How to call

POST /v1/execute (requires authentication)

Request bodyjson

{
  "skillKey": "schema.validate_graphql_schema",
  "input": {
    "schema": "type Query { ping: String }"
  }
}

Examples

A Query type with a String field is valid

Inputjson

{
  "schema": "type Query { ping: String }"
}

Expected outputjson

{
  "directiveCount": 0,
  "typeCount": 1,
  "truncated": false,
  "valid": true,
  "engine": "com.graphql-java:graphql-java",
  "diagnostics": []
}

Tip

A minimal Query SDL parses and produces valid true.

A field that names an undefined type is invalid