Skip to main content
Glama

GetSubgraphSchema

Read-onlyIdempotent

Read one subgraph's published schema (SDL) from a variant, with its routing URL, revision, and last update time. This is the same read that rover subgraph fetch performs. Read one subgraph at a time: a whole supergraph document is much larger and can pass the token limit of the model. Provide the graph ID, the variant name, and the subgraph name. Use GetVariantDetails first if you do not know the subgraph names. The revision is free text, such as a commit hash or "proposal-creation", and it can differ between two variants whose SDL is identical, so compare the SDL to tell whether a subgraph changed.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "graphId": "<graphId>",
      "variant": "<variant>",
      "subgraphName": "<subgraphName>"
    },
    "name": "GetSubgraphSchema"
  }
}

Input Schema

NameRequiredDescriptionDefault
graphIdYes
variantYes
subgraphNameYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so safety is covered. The description goes well beyond that by equating the call to `rover subgraph fetch`, warning about model token limits, and explaining that revision is free text (a commit hash or 'proposal-creation') that can differ across variants with identical SDL — so SDL, not revision, should be compared to detect change.

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 purpose and return fields are front-loaded, and each subsequent sentence adds distinct value: the rover equivalence, the one-at-a-time constraint, the prerequisite tool, and the revision caveat. Slightly long at five sentences, but no sentence is filler and each targets a different decision the agent must make.

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?

An output schema exists, so the description is not obliged to document the response shape, and it instead spends its words on selection guidance and behavioral quirks. For a simple three-required-string read tool with full annotation coverage, nothing needed to call it correctly is missing.

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

Parameters4/5

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

Schema description coverage is 0%, so the description carries the parameter burden: it names all three inputs (graph ID, variant name, subgraph name) and explains what 'revision' means as free text. It does not, however, give format hints for graphId or state whether variant/subgraph names are case-sensitive or slug-formatted, so the coverage gap is only mostly closed.

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 opens with a specific verb and resource ('Read one subgraph's published schema (SDL) from a variant') and enumerates the returned fields (routing URL, revision, last update time). It explicitly distinguishes itself from the supergraph-level sibling by explaining that a whole supergraph document is much larger, so an agent can route between GetSubgraphSchema and GetSupergraphSchema without opening either schema.

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

Usage Guidelines5/5

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

It gives explicit when-to-use guidance ('Read one subgraph at a time'), a stated precondition for the alternative ('Use GetVariantDetails first if you do not know the subgraph names'), and a practical exclusion (avoid whole-supergraph reads because of token limits). The required three inputs are restated as the call recipe, leaving little inference.

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