Skip to main content
Glama

GraphOS MCP Server

by io.github.apollographql
OverviewDiscussionsAdmin

GetVariantDetails

Read-onlyIdempotent

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").

Input Schema

NameRequiredDescriptionDefault
graphIdYes
variantYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedOutput schema / definitions
      Removed value: -{
-  "RouterStatus": {
-    "description": "Current status of Cloud Routers",
-    "enum": [
-      "CREATING",
-      "UPDATING",
-      "DELETING",
-      "ROLLING_BACK",
-      "RUNNING",
-      "SLEEPING",
-      "DELETED"
-    ],
-    "type": "string"
-  }
-}
    • addedOutput schema / properties / data / properties / graph / anyOf
      Added value: +[
+  {
+    "properties": {
+      "variant": {
+        "anyOf": [
+          {
+            "properties": {
+              "federationVersion": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "Federation version this variant uses"
+              },
+              "id": {
+                "description": "The variant's global identifier in the form `graphID@variant`.",
+                "oneOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "integer"
+                  }
+                ]
+              },
+              "name": {
+                "description": "The variant's name (e.g., `staging`).",
+                "type": "string"
+              },
+              "subgraphs": {
+                "anyOf": [
+                  {
+                    "items": {
+                      "properties": {
+                        "name": {
+                          "description": "The subgraph's name.",
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ],
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "A list of the subgraphs included in this variant. This value is null for non-federated variants. Set `includeDeleted` to `true` to include deleted subgraphs."
+              },
+              "url": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "The URL of the variant's GraphQL endpoint for query and mutation operations. For subscription operations, use `subscriptionUrl`."
+              }
+            },
+            "required": [
+              "id",
+              "name"
+            ],
+            "type": "object"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Provides details of the graph variant with the provided `name`, if a variant\nwith that name exists for this graph. Otherwise, returns null.\n\n For a list of _all_ variants associated with a graph, use `Graph.variants` instead."
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedOutput schema / properties / data / properties / graph / oneOf
      Removed value: -[
-  {
-    "properties": {
-      "variant": {
-        "description": "Provides details of the graph variant with the provided `name`, if a variant\nwith that name exists for this graph. Otherwise, returns null.\n\n For a list of _all_ variants associated with a graph, use `Graph.variants` instead.",
-        "oneOf": [
-          {
-            "properties": {
-              "federationVersion": {
-                "description": "Federation version this variant uses",
-                "oneOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              },
-              "id": {
-                "description": "The variant's global identifier in the form `graphID@variant`.",
-                "oneOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "type": "integer"
-                  }
-                ]
-              },
-              "name": {
-                "description": "The variant's name (e.g., `staging`).",
-                "type": "string"
-              },
-              "router": {
-                "description": "Router associated with this graph variant",
-                "oneOf": [
-                  {
-                    "properties": {
-                      "nextRouterVersion": {
-                        "description": "Cloud Router version applied for the next launch\n\nIf this value is not null, any subsequent launch will use this version instead of the\ncurrent one. This can happen when a new STABLE version is available, but we could not\nautomatically update this Cloud Router, for example due to configuration issues.",
-                        "oneOf": [
-                          {
-                            "properties": {
-                              "configVersion": {
-                                "description": "Config version for this router version",
-                                "type": "string"
-                              },
-                              "core": {
-                                "description": "Core version identifier",
-                                "type": "string"
-                              },
-                              "version": {
-                                "description": "Version identifier",
-                                "type": "string"
-                              }
-                            },
-                            "required": [
-                              "version",
-                              "core",
-                              "configVersion"
-                            ],
-                            "type": "object"
-                          },
-                          {
-                            "type": "null"
-                          }
-                        ]
-                      },
-                      "status": {
-                        "$ref": "#/definitions/RouterStatus",
-                        "description": "Current status of the Cloud Router"
-                      }
-                    },
-                    "required": [
-                      "status"
-                    ],
-                    "type": "object"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              },
-              "routerConfig": {
-                "oneOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              },
-              "subgraphs": {
-                "description": "A list of the subgraphs included in this variant. This value is null for non-federated variants. Set `includeDeleted` to `true` to include deleted subgraphs.",
-                "oneOf": [
-                  {
-                    "items": {
-                      "properties": {
-                        "name": {
-                          "description": "The subgraph's name.",
-                          "type": "string"
-                        }
-                      },
-                      "required": [
-                        "name"
-                      ],
-                      "type": "object"
-                    },
-                    "type": "array"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              },
-              "url": {
-                "description": "The URL of the variant's GraphQL endpoint for query and mutation operations. For subscription operations, use `subscriptionUrl`.",
-                "oneOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "type": "null"
-                  }
-                ]
-              }
-            },
-            "required": [
-              "id",
-              "name"
-            ],
-            "type": "object"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]
  2. First observed

TDQS

A4/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false. The description adds useful scope by noting that subgraph inventory is names only, but it does not add operational details such as authentication requirements, rate limits, or pagination behavior.

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?

The description is three short sentences with no wasted text. It front-loads the retrieval purpose, then states the intended assessment use case, then gives the required input guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter read tool with a rich annotation set and an output schema, the description is largely complete: it explains purpose, use case, and returned metadata categories. The only notable omission is graphId format guidance, which matters because the input schema itself has no parameter descriptions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/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 for both parameters. It names graphId and variant as required inputs and gives an example variant value ("production"), but it does not explain the expected format or source for graphId, leaving a meaningful gap.

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?

The description states a specific verb and resource: retrieve metadata for a graph variant. It enumerates the returned fields (identifier, federation version, endpoint URL, subgraph inventory names only), which clearly distinguishes it from sibling schema-retrieval tools.

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?

It gives a clear intended use case: assess a variant's composition setup, including subgraph inventory and federation version compliance. It does not explicitly say when not to use it or name alternatives such as GetGraphSchema or GetSubgraphSchema, so it falls short of full routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All GraphOS MCP Server toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources