Skip to main content
Glama

RunSchemaCheck

Start a schema check of a proposed schema against a variant, the same check that rover graph check starts. Use this for a monograph or for a whole supergraph schema; use RunSubgraphCheck for one subgraph. The check runs in the background, so this returns a workflow ID and a Studio URL, not a result. Pass the returned workflowID to GetCheckResults to read the outcome. Provide the graph ID, the variant name, and the proposed schema as SDL. Optionally provide the git branch and commit to label the run in Studio.

Input Schema

NameRequiredDescriptionDefault
branchNo
commitNo
graphIdYes
variantYes
proposedSchemaYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=true), so the description carries the real behavioral burden and does it: the check is asynchronous, it returns a workflow ID and Studio URL rather than a result, and the run can be labeled with branch/commit. This is exactly the kind of non-obvious trait an agent needs before calling.

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

Conciseness5/5

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

Six short sentences, front-loaded with what the tool does and what it returns, then routing, then parameter enumeration. Every sentence carries non-redundant information that is absent from the schema and annotations.

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?

Complete for a five-parameter async mutation: purpose, scope vs. sibling, return shape, and next-step tool are all covered. With an output schema present, the description needn't detail the payload, yet it still pre-empts the most likely misconception (expecting a synchronous result).

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 must compensate, and it does name all five parameters with meaning: graph ID, variant name, proposed schema as SDL, and optional branch/commit used to label the run in Studio. It stops short of format details (SDL syntax, variant naming conventions), so not quite a 5.

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?

States a specific verb and resource ('Start a schema check of a proposed schema against a variant') and anchors it to a known equivalent ('the same check that `rover graph check` starts'). It explicitly delineates scope against the sibling RunSubgraphCheck ('use RunSubgraphCheck for one subgraph').

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?

Gives an explicit when-to-use rule (monograph or whole supergraph schema) and names the alternative plus the condition that selects it (one subgraph → RunSubgraphCheck). It also routes the agent forward to GetCheckResults, so the full workflow is discoverable.

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