Skip to main content
Glama

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

TableJSON Schema
NameRequiredDescriptionDefault
graphIdYes
variantYes

Output Schema

TableJSON 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.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, covering the safety profile. The description adds beyond that by clarifying the scope of returned data, particularly that subgraph inventory is 'names only' and that this is a metadata lookup rather than a mutation.

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?

Two tightly written sentences with no filler. The first sentence states the operation and results; the second provides the use case and required parameter guidance. Everything earns its place.

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?

Given the low complexity (two required string parameters), the existing output schema, and annotations covering read-only/idempotent behavior, the description supplies the essential selection and invocation context. Nothing critical is missing for an agent to decide when to call this tool.

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?

Input schema has zero description coverage, so the description must compensate. It does identify the two required parameters and gives an example for variant ('production'), but it does not explain what a graphId is, how to obtain it, or acceptable formats for either parameter.

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 opens with a specific verb and resource: 'Retrieve metadata for a graph variant,' and enumerates the exact fields returned: identifier, federation version, endpoint URL, and subgraph inventory. This makes the tool's purpose immediately distinguishable from sibling tools focused on launches, metrics, or lint results.

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?

The description gives clear usage context: 'Use this to assess a variant's composition setup, such as subgraph inventory and federation version compliance.' It does not explicitly name alternatives or exclusion conditions, so it stops short of a perfect 5.

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