Skip to main content
Glama

Server Details

Search Apollo docs, specs, and best practices

If you are the author of this connector, you can claim ownership. Claimed connector authors can inspect health checks, view analytics, and manage their listing.
Status
Healthy
Uptime
100.0% over the last 24 hours
Last Tested
Transport
Streamable HTTP · MCP 2025-11-25
URL
ChatGPT
–
Claude
GraphOS MCP Tools

TDQS

A3.8/5.0

Scored across 52 tools

Disambiguation4/5

Most tools target a distinct resource+action (schema reads split cleanly into Graph/Supergraph/Subgraph, metrics split into Operation/Client/Subgraph, checker split into Schema/Subgraph), and the long descriptions actively steer the agent between near-neighbours. The remaining friction is real though: GetTopOperations vs GetOperationMetrics both answer 'which operations get traffic', and GetGraphSchema vs GetSupergraphSchema vs GetCheckResults-adjacent reads require careful reading to pick correctly.

Naming Consistency4/5

The dominant pattern is PascalCase VerbNoun (GetX, PublishX, CreateX, DeleteX, UpdateX, RunX) applied consistently across the large majority of the 52 tools. Deviations are minor: the doc tools invert to NounVerb (ApolloDocsSearch, ApolloDocsRead) and ApolloConnectorsSpec is a bare noun.

Tool Count2/5

52 tools is heavy even for a broad platform API, and several clusters are clearly decomposable — four separate UpdateProposal* tools, three metrics tools, three launch tools, three artifact tools. A GraphOS surface covering schema, proposals, checks, metrics, keys, artifacts and docs plausibly needs ~25-30 tools, not 50+.

Completeness3/5

Proposal lifecycle, check/lint, launch inspection, artifacts, persisted queries and API keys are covered end-to-end, but graph/variant lifecycle has holes: there is no create-graph, list-graphs, or variant create/delete, and subgraph listing only exists indirectly through GetVariantDetails. The descriptions repeatedly punt to `rover` CLI or Studio for those gaps, which agents cannot execute directly.

Available Tools

52 tools
AddProposalCommentAInspect

Add a comment to a schema proposal, the same action as commenting in GraphOS Studio. With no other options, the comment is a general comment on the proposal. To comment on one change, pass the schema coordinate (for example Query.products) and the subgraph name as schemaScope. To reply, pass the parent comment's ID. Returns the new comment's ID and message, or an error with a message. Provide the graph ID, the proposal variant name and latestRevision.id from GetProposal, and the message.

Inputs: graphId (required), message (required), revisionId (required), proposalVariant (required), +3 more. Returns: data, errors, extensions

ApolloConnectorsSpecA
Read-onlyIdempotent
Inspect

Returns the Apollo Connectors specification for guidance on creating or modifying GraphQL schemas that use @connect or @source.

Inputs: no named parameters. Returns: data, errors, extensions

ApolloDocsReadA
Read-onlyIdempotent
Inspect

Reads an Apollo documentation page by slug in chunks. Use slugs returned by ApolloDocsSearch.

Inputs: slug (required), chunkIndex (required). Returns: data, errors, extensions

ApolloDocsSearchA
Read-onlyIdempotent
Inspect

Searches official Apollo documentation for GraphQL, GraphOS, Apollo Router, Apollo Client, MCP Server, schema design, deployment, and Connectors. Returns URLs, slugs, and excerpts.

Inputs: query (required). Returns: data, errors, extensions

CreateApiKeyAInspect

Create an API key for an organization. The response contains the new key's value in token. It is a live credential, so give it to the user to store in a secret manager, and do not repeat it, log it, or pass it to another tool. Which key types you can create depends on how you authenticate. With the GraphOS sign-in (OAuth), you can create OPERATOR, SCIM, and GATEWAY keys. SUBGRAPH and VARIANT keys need a personal API key in the x-api-key header. With an operator key in x-api-key, you can create only GATEWAY keys, and a graph key can create none. No credential can create ROUTER keys. OPERATOR, SCIM, and GATEWAY keys also require the Org Admin role. GATEWAY keys are used by Apollo Gateway instances. Choose the narrowest type that does the job, and confirm the type and its resources with the user before you call this tool. Provide the organization ID, the key name, and the type. For a SUBGRAPH key, list each graphId, variantName, and subgraphName in resources.subgraphs. For a VARIANT key, list each graphId and variantName in resources.variants.

Inputs: name (required), type (required), organizationId (required), resources. Returns: data, errors, extensions

CreateProposalAInspect

Create a schema proposal against a source variant, the same action as Create proposal in GraphOS Studio. GraphOS creates a proposal variant that starts as a copy of the source variant's schema, and the proposal starts in DRAFT. Returns the proposal variant's name and the new proposal's ID and status, or an error with a message. To add schema changes, call PublishProposalRevision next. Provide the graph ID, the title, and the source variant name. Optionally provide a description.

Inputs: graphId (required), displayName (required), sourceVariant (required), description. Returns: data, errors, extensions

DeleteApiKeyA
Destructive
Inspect

Delete an API key from an organization, the same write that rover api-key delete performs. This cannot be undone, and every client that uses the key stops authenticating. Returns the deleted key's ID. Provide the organization ID and the key ID, which GetApiKeys returns.

Inputs: keyId (required), organizationId (required). Returns: data, errors, extensions

DeleteGraphA
Destructive
Inspect

Delete a graph, the same write that rover graph delete performs. This is a soft delete: the data is not removed permanently and Apollo support can restore the graph. Every variant of the graph stops serving, so confirm the graph ID with the user before you call this. Returns null on success. Provide the graph ID.

Inputs: graphId (required). Returns: data, errors, extensions

DeleteSubgraphA
Destructive
Inspect

Remove a subgraph from a variant and start composition, the same write that rover subgraph delete performs. Returns the composition errors that the removal causes. This deletes the subgraph from the variant and can break the running router. Set dryRun to true first: the response then reports the composition result that the removal would produce, including updatedGateway, and deletes nothing. Provide the graph ID, the variant name, and the subgraph name.

Inputs: graphId (required), variant (required), subgraphName (required), dryRun. Returns: data, errors, extensions

GetApiKeysA
Read-onlyIdempotent
Inspect

List the API keys and client-credential pairs of an organization. For each key: its ID, name, type, creation, expiry, last use, revocation time, and the resources it can access. For each client-credential pair (an OAuth client that authenticates with the client credentials grant): its client ID, name, creation time, creator, grant types, scopes, and the resources it can access. Key values and client secrets are never returned. Pass a key's ID to RenameApiKey or DeleteApiKey. Those tools do not work on pairs, so manage pairs in GraphOS Studio or with rover api-key. Provide the organization ID, which GetMyIdentity returns. Optionally filter keys by status (ACTIVE by default, or ALL, EXPIRED, REVOKED) and type (OPERATOR, SUBGRAPH, VARIANT, GATEWAY, SCIM). The filters do not apply to pairs. The two lists page separately: page keys with first and after, and pairs with pairsFirst and pairsAfter.

Inputs: organizationId (required), type, after, first, +3 more. Returns: data, errors, extensions

GetCheckResultsA
Read-onlyIdempotent
Inspect

Read the outcome of one schema check run: the overall status, and for each task in the run the composition errors, lint diagnostics, schema changes with the client operations they affect, downstream variant results, and custom check violations. Get a check ID from GetSchemaChecks, from latestRevision.checkWorkflow.id in GetProposal (null if no check was triggered), or from the workflowID that RunSubgraphCheck returns. Provide the graph ID and the check ID. Read baseVariant before you compare the changes with another diff. For a proposal's check, baseVariant can name the proposal variant, but the changes are measured against the source variant as of the proposal's creation or its last upstream pull, so they cover every revision of the proposal and leave out later upstream changes. implementingServiceName may not match the subgraph whose changes are listed, so read the changes themselves. numberOfCheckedOperations of 0 means no client operations were tested, not that none are affected. An empty list of affected operations covers only operations seen in the graph's usage data, so it does not prove that a change is safe. The affected operations are paged with affectedOperationsLimit and affectedOperationsOffset; the change list is capped by the server, and areChangesTruncated reports when that happened.

Inputs: checkId (required), graphId (required), affectedOperationsLimit, affectedOperationsOffset. Returns: data, errors, extensions

GetClientMetricsA
Read-onlyIdempotent
Inspect

Traffic broken down by client for a graph over a time window, as compact CSV. Columns: start timestamp, end exclusive timestamp, client name, client version, operation name, request count, request latency p50 ms, request latency p99 ms, request with error count. Answers which clients call a graph, which client versions are still on the wire, and which client drives errors or latency. Clients that do not report apollographql-client-name/-version come back with empty name and version columns. Ranked by orderBy descending: default REQUEST_COUNT (busiest); REQUEST_WITH_ERROR_COUNT for most error-prone, REQUEST_LATENCY_P99_MS for slowest. variantName and operationName scope to one or more variants or operations by exact name (omit for all). Rows are one per client + version + operation, so a busy graph has far more groups than the other metrics tools: scope by operationName or raise limit when a breakdown looks truncated. Keep the default resolution of ENTIRE_RANGE for totals and top-N, which gives one row per group ranked over the whole window. DAY/HOUR/MINUTE give one row per group per bucket ranked within each bucket, so a window total then needs a per-group sum plus a limit big enough to cover every bucket; too small a limit silently undercounts. Only HOUR and MINUTE accept a to of now, so use them for bursts in the last 24 hours. Avoid MONTH: it labels buckets by calendar month, not by the requested window.

Inputs: to (required), from (required), graphId (required), limit, +4 more. Returns: data, errors, extensions

GetContractConfigA
Read-onlyIdempotent
Inspect

Read the filter configuration of a contract variant: the tags it includes, the tags it excludes, the source variant it is built from, and a human-readable description of the configuration. This is the same read that rover contract describe performs. A contract variant is a filtered view of another variant's schema, built by including and excluding schema elements by tag. The filter configuration does not include whether unreachable types are hidden. The description states it, so read it there before you update a contract with PublishContract. A variant that is not a contract returns null for the filter configuration. Provide the graph ID and the contract variant name.

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

GetGraphArtifactA
Read-onlyIdempotent
Inspect

Fetch a graph artifact by its digest, the same lookup that rover graph-artifact fetch --digest performs. A graph artifact is the build output, such as the composed supergraph schema, that GraphOS Router fetches from Apollo's OCI registry. Returns the artifact's ID, digest, status (GRAPH_ARTIFACT_COMPLETED, GRAPH_ARTIFACT_PENDING, or GRAPH_ARTIFACT_FAILED), build errors, timestamps, variant, the launch that produced it, its registry URI, and the tags assigned to it. To find a digest from a tag name, use GetGraphArtifactTags. Provide the graph ID and the digest.

Inputs: digest (required), graphId (required). Returns: data, errors, extensions

GetGraphArtifactTagsA
Read-onlyIdempotent
Inspect

List the graph artifact tags on a graph and the artifact each tag points to: the artifact's ID, digest, status, creation time, and variant. GraphOS Router can fetch an artifact by tag name instead of by digest. It is similar to rover graph-artifact list-tags, which filters by artifact digest instead of variant. Use it to find a tag or a digest before you call GetGraphArtifact, TagGraphArtifact, or UntagGraphArtifact. Provide the graph ID. Optionally filter by variant name, and page with first (at most 20) and after.

Inputs: graphId (required), after, first, variant. Returns: data, errors, extensions

GetGraphSchemaA
Read-onlyIdempotent
Inspect

Read the schema (SDL) that is currently published to a graph variant, with its hash and publication time. This is the same read that rover graph fetch performs. The response holds the whole document and is not truncated. A large federated graph measured over 800,000 characters, roughly 200,000 tokens, which exceeds the context window of most models. Prefer GetSubgraphSchema, which reads one subgraph at a time, and use this tool only when you need the whole API schema. Provide the graph ID and the variant name.

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

GetLatestLaunchA
Read-onlyIdempotent
Inspect

Inspect the most recent launch for a graph variant: status, completion time, subgraph changes, composition errors, and a schema diff summary vs the previous launch (additions/removals/edits/deprecations plus affected operations). Use to assess schema composition health and the impact of recent schema changes. Also returns the latest approved launch for comparison. Provide the graph ID and variant name.

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

GetLaunchA
Read-onlyIdempotent
Inspect

Inspect a single launch by ID for full detail: status, timestamps, which subgraphs changed, composition errors, and the schema diff summary. Use to drill into a specific launch — e.g. a failed or superseded one found via GetLaunchHistory (pass its id here). Provide the graph ID, variant name, and launch ID.

Inputs: graphId (required), variant (required), launchId (required). Returns: data, errors, extensions

GetLaunchHistoryA
Read-onlyIdempotent
Inspect

Retrieve recent launches for a graph variant (most recent first) to detect deployment instability such as repeated failures or frequent superseded launches. Each entry includes the launch id, status, and timestamps, so you can identify a specific launch and drill into it with GetLaunch. Use to assess deployment stability. Provide the graph ID, variant name, and optionally a limit (default 20 most recent launches, max 100 per page) and an offset to page further back.

Inputs: graphId (required), variant (required), limit, offset. Returns: data, errors, extensions

GetLintResultsA
Read-onlyIdempotent
Inspect

Retrieve schema lint violations from a graph's most recent schema checks: for each check, the subgraph and variant it ran against and when it completed, and each diagnostic's coordinate, severity level, message, rule, and source location, plus error/warning/total/ignored counts. These are past check results, not a lint of the current schema; use LintSchema to lint a schema now. Provide the graph ID. Without filters the results span every variant and subgraph on the graph, so pass variants and subgraphs to narrow them, and check implementingServiceName, baseVariant, and completedAt on each result. Optionally set a limit (default 5 most recent schema checks).

Inputs: graphId (required), limit, variants, subgraphs. Returns: data, errors, extensions

GetMyIdentityA
Read-onlyIdempotent
Inspect

Resolve the caller's identity from their API key or OAuth token. Call this FIRST when the user asks about "my graph" but has not provided a graph ID. For a graph/service key, me resolves to a Graph: use id as the graphId and variants[].name as the variant for the graph-scoped health-check tools, so the user does not have to supply either. For a user (personal key or OAuth), me resolves to a User instead: there's no single graph, so each org membership's graphs[].id / graphs[].variants[].name lists the graphId/variant options the graph-scoped tools need, across every org the user belongs to. Also handles service-account keys.

Inputs: no named parameters. Returns: data, errors, extensions

GetOfflineLicenseA
Read-onlyIdempotent
Inspect

Fetch the offline Enterprise license for the organization that owns a graph, the same data that rover license fetch returns. The license is a signed JWT that lets GraphOS Router enable Enterprise features while it runs disconnected from GraphOS. Returns null when the organization does not have offline licenses enabled, which requires a request to Apollo. Provide the graph ID.

Inputs: graphId (required). Returns: data, errors, extensions

GetOperationMetricsA
Read-onlyIdempotent
Inspect

Top operations by usage/health for a graph over a time window, as compact CSV. Columns: start timestamp, end exclusive timestamp, operation name, request count, request latency p50 ms, request latency p99 ms, request with error count. Ranked by orderBy descending: default REQUEST_COUNT (busiest); REQUEST_WITH_ERROR_COUNT for most error-prone, REQUEST_LATENCY_P99_MS for slowest. variantName scopes to one or more variants (omit for all). clients scopes to one or more clients; omit clientVersion to match every version of that client, and use GetClientMetrics to discover the names a graph sees. Keep the default resolution of ENTIRE_RANGE for totals and top-N, which gives one row per operation ranked over the whole window. DAY/HOUR/MINUTE give one row per operation per bucket ranked within each bucket, so a window total then needs a per-operation sum plus a limit big enough to cover every bucket; too small a limit silently undercounts. Only HOUR and MINUTE accept a to of now, so use them for bursts in the last 24 hours. Avoid MONTH: it labels buckets by calendar month, not by the requested window.

Inputs: to (required), from (required), graphId (required), limit, +4 more. Returns: data, errors, extensions

GetOrganizationMembersA
Read-onlyIdempotent
Inspect

List the members of a GraphOS organization with each member's user ID, name, and email. UpdateProposalReviewers takes these user IDs. Match the person the user named, by email when names are ambiguous, and do not list the other members back to the user. The list is not paginated, so a large organization returns every member. This tool needs the GraphOS sign-in (OAuth) or a personal API key in the x-api-key header. A graph key cannot read the members and gets NOT_ALLOWED_BY_USER_ROLE. Provide the organization ID, which GetMyIdentity returns.

Inputs: organizationId (required). Returns: data, errors, extensions

GetPersistedQueryListStatusA
Read-onlyIdempotent
Inspect

Check whether a graph variant has a Persisted Query List (PQL), and return its ID, its name, and its current build (revision and operation count). Pass the ID to PublishPersistedQueries. Use to assess PQL configuration — a production variant with no PQL is a security gap. Provide the graph ID and variant name.

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

GetProposalA
Read-onlyIdempotent
Inspect

Read one schema proposal by its ID: title, description, status, author, the source variant, and the proposal variant with the ID of its latest launch. Also returns the latest revision (its ID, summary, schema check, and launch), every review with its decision and comment, and whether the source variant changed since the proposal was created. hasUpstreamChanges does not say which subgraphs changed upstream. The proposal variant starts as a copy of every subgraph on the source variant and is not updated automatically; it picks up upstream changes only when the author pulls them in. So a diff of the two variants also shows changes published to the source since the proposal was created or last pulled upstream, reversed as if the proposal made them. hasUpstreamChanges is always false for proposals created before Nov 15, 2024. To see what the proposal itself changes, read its latest check with latestRevision.checkWorkflow.id and GetCheckResults: the check's changes cover every revision of the proposal and leave out upstream changes. If you diff the variants, compare each source subgraph's updatedAt with when the proposal was created or last pulled upstream, and do not treat a subgraph that is on only one side as added or removed by the proposal. GetVariantDetails lists the subgraph names on each variant. The write tools for a proposal take the graph ID and the proposal variant name from this response. ReviewProposal and AddProposalComment take latestRevision.id, and PublishProposalRevision takes backingVariant.latestLaunch.id as previousLaunchId. Provide the proposal ID, which GetProposals returns.

Inputs: proposalId (required). Returns: data, errors, extensions

GetProposalsA
Read-onlyIdempotent
Inspect

List the schema proposals on a graph: each proposal's ID, title, status (DRAFT, OPEN, APPROVED, IMPLEMENTED, CLOSED), timestamps, author, the source variant it proposes changes to, and the proposal variant that holds its changes, plus the total count for the filter. A schema proposal is a reviewable set of schema changes that GraphOS stores on its own variant. Pass a proposal's id to GetProposal for its revisions and reviews. Provide the graph ID. Optionally filter by status, source variant names, or subgraph names, and page with limit and offset.

Inputs: graphId (required), limit, offset, status, +2 more. Returns: data, errors, extensions

GetReadmeA
Read-onlyIdempotent
Inspect

Read the README of a graph variant, with the time it was last updated and who updated it. This is the same read that rover readme fetch performs. The README is the Markdown document shown on the variant's page in GraphOS Studio. Provide the graph ID and the variant name.

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

GetSchemaChecksA
Read-onlyIdempotent
Inspect

List past schema checks for a graph: each check's ID, status, timestamps, the subgraph it checked, the variant it ran against, the commit, and the status of each task in the check, plus the total count for the filter. Use this to find a check, then pass its ID to GetCheckResults for failure details. Provide the graph ID. Optionally filter by status (PASSED, FAILED, PENDING), subgraph names, branches, variants, authors, or check IDs, and page with limit and offset.

Inputs: graphId (required), ids, limit, offset, +5 more. Returns: data, errors, extensions

GetSubgraphMetricsA
Read-onlyIdempotent
Inspect

Top subgraphs/connectors by traffic/health for a graph over a time window, as compact CSV. Columns: start timestamp, end exclusive timestamp, fetch service name, fetch count, fetch latency p50 ms, fetch latency p99 ms, fetch with errors count. Ranked by orderBy descending: default FETCH_COUNT (busiest); FETCH_WITH_ERRORS_COUNT for most error-prone, FETCH_LATENCY_P99_MS for slowest. variantName scopes to one or more variants (omit for all). subgraphName scopes to one or more subgraphs by exact name (omit for all); pattern/substring matching is not supported. clients scopes to the fetches driven by one or more clients; omit clientVersion to match every version of that client, and use GetClientMetrics to discover the names a graph sees. Keep the default resolution of ENTIRE_RANGE for totals and top-N, which gives one row per subgraph ranked over the whole window. DAY/HOUR/MINUTE give one row per subgraph per bucket ranked within each bucket, so a window total then needs a per-subgraph sum plus a limit big enough to cover every bucket; too small a limit silently undercounts. Only HOUR and MINUTE accept a to of now, so use them for bursts in the last 24 hours. Avoid MONTH: it labels buckets by calendar month, not by the requested window.

Inputs: to (required), from (required), graphId (required), limit, +5 more. Returns: data, errors, extensions

GetSubgraphSchemaA
Read-onlyIdempotent
Inspect

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.

Inputs: graphId (required), variant (required), subgraphName (required). Returns: data, errors, extensions

GetSupergraphSchemaA
Read-onlyIdempotent
Inspect

Read the composed supergraph schema (SDL) for a graph variant, with the composition ID and any composition errors. This is the same read that rover supergraph fetch performs. A supergraph schema is the single schema that composition builds from every subgraph, and it carries federation directives that the API schema does not. The response holds the whole document and is not truncated, and a supergraph schema is larger than the API schema it produces. Expect the same order of size: a large federated graph exceeds 800,000 characters, roughly 200,000 tokens. A variant that is not federated has no composition result, and the tool returns null for it rather than an empty document. Provide the graph ID and the variant name.

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

GetTopOperationsA
Read-onlyIdempotent
Inspect

Identify the most-used operations on a graph variant for a time range, with request counts, types, and signatures. Use to find high-traffic operations, detect unused operations, and prioritize findings by traffic impact. Provide graph ID, variant, and a from/to time range (ISO 8601 timestamps; to must be at least 6 hours before now), plus an optional limit (default 50). This report is rate limited.

Inputs: to (required), from (required), graphId (required), variant (required), +1 more. Returns: data, errors, extensions

GetVariantDetailsA
Read-onlyIdempotent
Inspect

Retrieve metadata for a graph variant: its identifier, federation version, the URL of its GraphQL endpoint, and its subgraph inventory (names only). Use this to assess a variant's composition setup, such as subgraph inventory and federation version compliance. Provide the graph ID and variant name (e.g., "production").

Inputs: graphId (required), variant (required). Returns: data, errors, extensions

LintSchemaA
Read-onlyIdempotent
Inspect

Lint a GraphQL schema document against the graph's lint rules and return each diagnostic's coordinate, severity level, message, rule, and source location, plus the error, warning, total, and ignored counts. This is the same check that rover graph lint and rover subgraph lint run. Nothing is published and no state changes. Provide the graph ID and the schema as SDL. The rules that run are the ones enabled in the graph's linter configuration, so a missing diagnostic can mean the rule is turned off. Optionally provide baseSdl to report only the diagnostics that the new schema introduces against that base; empty diagnostics then mean the new schema introduces no violations of the enabled rules, and ignored diagnostics are counted in ignoredCount, not listed.

Inputs: sdl (required), graphId (required), baseSdl. Returns: data, errors, extensions

PublishContractA
Destructive
Inspect

Create or update a contract variant and start a launch for it, the same write that rover contract publish performs. A contract variant is a filtered view of another variant's schema, built by including and excluding schema elements by tag. The filter configuration replaces the previous one in full, so send the complete include and exclude lists rather than only the tags you want to change. The same applies to hideUnreachableTypes, which has no default: when you update a contract, pass the value it has now. GetContractConfig states that value in its description. Returns the contract variant and a link to the launch, or the error messages that stopped it. Provide the graph ID, the contract variant name, the source variant, the include and exclude tag lists, and whether to hide unreachable types.

Inputs: exclude (required), graphId (required), include (required), contractVariant (required), +3 more. Returns: data, errors, extensions

PublishGraphSchemaA
Destructive
Inspect

Publish a schema to a graph variant, the same write that rover graph publish performs. Use this for a monograph; use PublishSubgraph for one subgraph of a federated graph. Returns a result code, whether the publish succeeded, a human-readable message, and the hash of the published schema. This changes the schema registry and can change what clients see. Run RunSchemaCheck first to see the effect on client operations. Provide the graph ID, the variant name, and the schema as SDL. Optionally provide the git branch and commit to label the publication.

Inputs: graphId (required), variant (required), schemaDocument (required), branch, +1 more. Returns: data, errors, extensions

PublishPersistedQueriesA
Destructive
Inspect

Publish operations to a persisted query list, the same write that rover persisted-queries publish performs. A persisted query list is the set of operations a router accepts when it is configured to reject anything else. Operations you do not mention stay in the list unchanged: pass operations to add or replace entries, and remove to drop them. Returns the new revision and the total operation count, or reports that nothing changed. Use GetPersistedQueryListStatus to find the list ID and its current revision. Provide the graph ID and the persisted query list ID.

Inputs: listId (required), graphId (required), remove, operations, +1 more. Returns: data, errors, extensions

PublishProposalRevisionA
Destructive
Inspect

Save a new revision of a schema proposal by publishing changed subgraph schemas to its proposal variant, the same action as Save revision in GraphOS Studio. GraphOS composes the proposal variant, records the diff against the source variant, and runs schema checks on it. The source variant does not change. Send only the subgraphs that change, each with its full SDL. previousLaunchId must be the proposal variant's latest launch ID from GetProposal. If someone saved a revision since, the call fails, so read the proposal again before you retry. GraphOS saves the revision even when the schema does not compose, so this call succeeding does not mean the change is valid. Call GetProposal after the check finishes: latestRevision.checkWorkflow.status and latestRevision.launch.status show the result, and GetCheckResults takes the check ID for the details. Returns the proposal's new latest revision, or an error with a message. Provide the graph ID, the proposal variant name, previousLaunchId, a unique revision label, a summary of the change, and the subgraphs.

Inputs: graphId (required), summary (required), revision (required), subgraphs (required), +3 more. Returns: data, errors, extensions

PublishReadmeA
Destructive
Inspect

Replace the README of a graph variant, the same write that rover readme publish performs. The README is the Markdown document shown on the variant's page in GraphOS Studio. The new text replaces the whole README, so read the current one with GetReadme first if you intend to keep any of it. Provide the graph ID, the variant name, and the full README text.

Inputs: readme (required), graphId (required), variant (required). Returns: data, errors, extensions

PublishSubgraphA
Destructive
Inspect

Publish a subgraph schema to a variant and start composition, the same write that rover subgraph publish performs. Returns whether the subgraph was created or updated, any composition errors, and the launch that started. This changes the schema registry and can change what the router serves. Run RunSubgraphCheck first to see the effect on client operations. Provide the graph ID, the variant name, the subgraph name, and the schema as SDL. Provide the routing URL when you add a subgraph or move its endpoint. Optionally provide a revision label and the git branch and commit.

Inputs: sdl (required), graphId (required), variant (required), subgraphName (required), +4 more. Returns: data, errors, extensions

RenameApiKeyA
DestructiveIdempotent
Inspect

Rename an API key in an organization, the same write that rover api-key rename performs. The key value and its access do not change. Returns the key's ID and new name. Provide the organization ID, the key ID, which GetApiKeys returns, and the new name.

Inputs: name (required), keyId (required), organizationId (required). Returns: data, errors, extensions

ReviewProposalA
DestructiveIdempotent
Inspect

Approve or reject a revision of a schema proposal, with an optional comment, the same action as Review in GraphOS Studio. Only a requested reviewer can review, and calling this again replaces the caller's earlier review. Returns the proposal's status and its reviews, or an error with a message. Provide the graph ID, the proposal variant name and latestRevision.id from GetProposal, and the decision (APPROVED or NOT_APPROVED).

Inputs: graphId (required), decision (required), revisionId (required), proposalVariant (required), +1 more. Returns: data, errors, extensions

RunSchemaCheckAInspect

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.

Inputs: graphId (required), variant (required), proposedSchema (required), branch, +1 more. Returns: data, errors, extensions

RunSubgraphCheckAInspect

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.

Inputs: graphId (required), variant (required), subgraphName (required), proposedSchema (required), +2 more. Returns: data, errors, extensions

TagGraphArtifactA
Destructive
Inspect

Assign a tag to a graph artifact, the same write that rover graph-artifact tag performs. If the tag does not exist, it is created. If it exists, it moves to this artifact, and any router that fetches by that tag receives the new artifact. Returns the artifact's ID and digest, or an error with a message. Provide the graph ID, the tag name, and the artifact digest.

Inputs: tag (required), digest (required), graphId (required). Returns: data, errors, extensions

UntagGraphArtifactA
Destructive
Inspect

Delete a graph artifact tag from a graph, the same write that rover graph-artifact untag performs. The tag and its full history are removed, and any router that fetches by that tag can no longer resolve it. The artifact itself stays. Tags that Apollo manages, such as a variant's latest tag, cannot be deleted. Returns the deleted tag name, or an error with a message. Provide the graph ID and the tag name.

Inputs: tag (required), graphId (required). Returns: data, errors, extensions

UpdateProposalDescriptionA
DestructiveIdempotent
Inspect

Replace the description of a schema proposal, the same action as editing the description in GraphOS Studio. The new text replaces the whole description, so to add to it, read the current description with GetProposal and send the full text. GraphOS rejects a description longer than 10,000 characters with a ValidationError. Returns the proposal's ID and new description, or an error with a message. Provide the graph ID, the proposal variant name from GetProposal, and the new description.

Inputs: graphId (required), description (required), proposalVariant (required). Returns: data, errors, extensions

UpdateProposalReviewersA
Destructive
Inspect

Add or remove requested reviewers on a schema proposal, the same action as the Reviewers menu in GraphOS Studio. While the proposal is open, GraphOS emails each reviewer you add, every time, including someone already requested. Adding to a DRAFT proposal and removing a reviewer send no email. Only a requested reviewer can call ReviewProposal. Both lists take GraphOS user IDs, which GetOrganizationMembers returns. Pass either list or both. Only organization members can be reviewers, and GraphOS returns a ValidationError that names any other ID. The proposal's author cannot be a reviewer. This tool needs the GraphOS sign-in (OAuth) or a personal API key in the x-api-key header. GraphOS checks reviewers against the organization's members, which a graph key cannot read, so the call fails with NOT_ALLOWED_BY_USER_ROLE. The Platform API does not return the list of requested reviewers, so this tool cannot read it back. Check the proposal in GraphOS Studio to see it. Adding a reviewer who is already requested, removing one who is not, or passing neither list still returns the proposal, so a success does not mean anything changed. Remove only the people the user named. Returns the proposal's ID, or an error with a message. Provide the graph ID, the proposal variant name from GetProposal, and the user IDs to add, to remove, or both.

Inputs: graphId (required), proposalVariant (required), reviewerUserIdsToAdd, reviewerUserIdsToRemove. Returns: data, errors, extensions

UpdateProposalStatusA
Destructive
Inspect

Change the status of a schema proposal, the same action as the status menu in GraphOS Studio. DRAFT is for work in progress, OPEN asks reviewers to review, and CLOSED abandons the proposal. GraphOS accepts APPROVED only when the proposal has as many approvals as the graph requires, and it never accepts IMPLEMENTED from this tool. Both return a ValidationError that names the rule. Returns the proposal's ID and new status. Provide the graph ID, the proposal variant name from GetProposal, and the new status.

Inputs: status (required), graphId (required), proposalVariant (required). Returns: data, errors, extensions

UpdateProposalTitleA
DestructiveIdempotent
Inspect

Change the title of a schema proposal, the same action as renaming a proposal in GraphOS Studio. Returns the proposal's ID and new title, or an error with a message. Provide the graph ID, the proposal variant name from GetProposal, and the new title.

Inputs: title (required), graphId (required), proposalVariant (required). Returns: data, errors, extensions

ValidateOperationsA
Read-onlyIdempotent
Inspect

Validate client GraphQL operations against a variant's published schema and return each problem's type (FAILURE, WARNING, INVALID), code, description, and the name of the operation it came from. This is the same check that rover client check runs. Nothing is published and no state changes. Provide the graph ID and the operations, each one a body and an optional name. Optionally name the variant to validate against; the default is "current".

Inputs: graphId (required), operations (required), variant. Returns: data, errors, extensions

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Related MCP Connectors

    Related MCP Servers

    Try in Browser

    Glama MCP Gateway

    Add one secure layer between your agents and this server.

    Resources