Skip to main content
Glama

GetSupergraphSchema

Read-onlyIdempotent

Read the composed supergraph schema (SDL) for a graph variant, with the composition ID and any composition errors. This is the same read that rover supergraph fetch performs. A supergraph schema is the single schema that composition builds from every subgraph, and it carries federation directives that the API schema does not. The response holds the whole document and is not truncated, and a supergraph schema is larger than the API schema it produces. Expect the same order of size: a large federated graph exceeds 800,000 characters, roughly 200,000 tokens. A variant that is not federated has no composition result, and the tool returns null for it rather than an empty document. Provide the graph ID and the variant name.

Input Schema

NameRequiredDescriptionDefault
graphIdYes
variantYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description discloses critical behavioral traits: the response is the whole untruncated document, can be extremely large (~800,000 characters / ~200,000 tokens), and returns null for non-federated variants rather than an empty document. These details are essential for an agent to invoke and handle the tool correctly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with purpose and includes useful context, but it is somewhat verbose. The size warning is important, though slightly repetitive across sentences. Overall it is appropriately structured for a tool with significant behavioral caveats.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the rich annotations, the existing output schema, and the detailed description of size, null behavior, and composition metadata, the definition is complete enough for an agent to call the tool correctly. No major contextual gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 0% description coverage, so the description must clarify the two parameters. It only says 'Provide the graph ID and the variant name,' without explaining expected formats, how to obtain these values, or variant naming conventions. This is minimally viable but leaves gaps.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: reading the composed supergraph schema (SDL) for a graph variant, including composition ID and errors. It clearly distinguishes this from the API schema and subgraphs by explaining that supergraph schemas carry federation directives. An agent can tell exactly what this tool retrieves.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear context for when to use the tool, equating it to `rover supergraph fetch` and noting that non-federated variants return null. However, it does not explicitly name alternatives such as GetGraphSchema or GetSubgraphSchema or state when not to use this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources