Skip to main content
Glama

RunSubgraphCheck

Start a schema check of one proposed subgraph schema against a variant, the same check that rover subgraph check starts. The check runs in the background, so this returns a workflow ID and a Studio URL, not a result. Nothing is published, but the check run is recorded and shows in Studio. Pass the returned workflowID to GetCheckResults as checkId to read the outcome. Provide the graph ID, the variant name, the subgraph name, and the proposed subgraph schema as SDL. Optionally provide the git branch and commit to label the run in Studio.

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>",
      "proposedSchema": "<proposedSchema>"
    },
    "name": "RunSubgraphCheck"
  }
}

Input Schema

NameRequiredDescriptionDefault
branchNo
commitNo
graphIdYes
variantYes
subgraphNameYes
proposedSchemaYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=true; the description adds the genuinely useful traits of asynchronous execution, a workflow ID plus Studio URL instead of a result, and that nothing is published while the run is still recorded in Studio. That is real context beyond the annotations, though it says nothing about permissions or check duration.

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?

Five short sentences, each earning its place: what it does, that it is async, the side effect, the follow-up call, the required inputs, the optional inputs. Execution semantics and the result-reading path are front-loaded.

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?

For a six-parameter async mutation with an output schema, the description covers purpose, side effects, required and optional inputs, and how to retrieve the result. Nothing an agent needs in order to call it and act on the response 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 must carry the burden, and it does: it enumerates graph ID, variant, subgraph name, proposed schema as SDL, and optional branch/commit 'to label the run in Studio,' covering all six parameters. It stops short of format details such as what a variant value looks like or why the schema is a GraphQLDocument reference.

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 one proposed subgraph schema against a variant') and anchors it to a known equivalent ('the same check that `rover subgraph check` starts'), which lets an agent separate it from the whole-graph RunSchemaCheck sibling without opening a schema.

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?

Gives explicit follow-up routing: 'Pass the returned workflowID to GetCheckResults as checkId to read the outcome,' and names the required inputs. It does not state when to prefer this over the sibling RunSchemaCheck, so it stops short of full alternative coverage.

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