Home / Directory / Apollo GraphOS / RunSubgraphCheck
RunSubgraphCheck
An MCP tool from the Apollo GraphOS server, run by Apollo.
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. Pass the returned workflowID to GetCheckResults 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.
Name on the gateway: apollo_graphos__RunSubgraphCheck.
Parameters
| Name | Type | Description |
|---|---|---|
graphId required | string | |
variant required | string | |
subgraphName required | string | |
proposedSchema required | any | |
branch | mixed | |
commit | mixed |
How to call it
Through the Smart Gateway, any client can run it by name with call_tool, or let the gateway find it with search_tools:
{
"name": "apollo_graphos__RunSubgraphCheck",
"arguments": {
"graphId": "…",
"variant": "…",
"subgraphName": "…",
"proposedSchema": "…"
}
}The first call connects Apollo GraphOS to your account automatically; nothing to set up. About this server.
Try asking
Use the runsubgraphcheck tool with graphId set to ….