Home / Directory / Apollo GraphOS / RunSchemaCheck
RunSchemaCheck
An MCP tool from the Apollo GraphOS server, run by Apollo.
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.
Name on the gateway: apollo_graphos__RunSchemaCheck.
Parameters
| Name | Type | Description |
|---|---|---|
graphId required | string | |
variant required | string | |
proposedSchema required | string | |
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__RunSchemaCheck",
"arguments": {
"graphId": "…",
"variant": "…",
"proposedSchema": "…"
}
}The first call connects Apollo GraphOS to your account automatically; nothing to set up. About this server.
Try asking
Use the runschemacheck tool with graphId set to ….