Skip to main content
Glama

List Workload Deployments

list_deployments
Read-onlyIdempotent

A workload's deployments: its per-location rollout status. This is the PRIMARY readiness check after create_workload/update_workload: pass waitSeconds to wait on the server until ready, then report the canonical endpoint as the public URL, never a URL built by hand. Without location: every location with readiness, endpoints, and the canonical URL. Each location also names its running replicas, the --replica value for cpln workload exec, cpln workload connect, cpln cp, and cpln port-forward. For cron workloads, per-execution run history lives in status.jobExecutions of the per-location detail. A location that reports an error: diagnose_workload.

Input Schema

NameRequiredDescriptionDefault
gvcYesGVC name.
orgNoOrganization slug.
locationNoOPTIONAL. A workload has one deployment per location it runs in. Omit for readiness across ALL locations plus the canonical public URL. Pass a location (e.g. "aws-us-east-1") for that single deployment's full detail — version chain, per-container readiness, and full JSON.
workloadYesWorkload whose deployments to inspect.
waitSecondsNoSeconds to wait on the server until every listed location is ready, 0 to 45. The call returns as soon as it is, or with the latest state when the time runs out. Use this instead of calling again and again.

Output Schema

NameRequiredDescriptionDefault
okYes
dataNoThe full result. Read this, not only the summary.
detailsNo
summaryYes
nextStepsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / gvc / description
      Previous value: -"GVC slug. If the user named none, list_resources (kind \"gvc\") and let them choose."New value: +"GVC name."
  2. Changed25 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / gvc / description
      Previous value: -"GVC slug (lowercase kebab-case). Use the GVC the user named; otherwise discover with list_resources (kind=\"gvc\") and let them choose — never guess (a wrong GVC targets the wrong environment)."New value: +"GVC slug. If the user named none, list_resources (kind \"gvc\") and let them choose."
    • removedInput schema / properties / gvc / maxLength
      Removed value: -63
    • removedInput schema / properties / gvc / minLength
      Removed value: -1
    • removedInput schema / properties / gvc / pattern
      Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"
    • removedInput schema / properties / location / maxLength
      Removed value: -64
    • removedInput schema / properties / location / minLength
      Removed value: -2
    • removedInput schema / properties / location / pattern
      Removed value: -"^[a-z]([-a-z0-9])*[a-z0-9]$"
    • changedInput schema / properties / org / description
      Previous value: -"Organization slug (lowercase kebab-case). NEVER guess — if the user has not named one, ask. On org-not-found, stop and ask; do not retry variants."New value: +"Organization slug."
    • removedInput schema / properties / org / maxLength
      Removed value: -63
    • removedInput schema / properties / org / minLength
      Removed value: -1
    • removedInput schema / properties / org / pattern
      Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"
    • addedInput schema / properties / waitSeconds
      Added value: +{
      +  "description": "Seconds to wait on the server until every listed location is ready, 0 to 45. The call returns as soon as it is, or with the latest state when the time runs out. Use this instead of calling again and again.",
      +  "maximum": 45,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • removedInput schema / properties / workload / maxLength
      Removed value: -64
    • removedInput schema / properties / workload / minLength
      Removed value: -2
    • removedInput schema / properties / workload / pattern
      Removed value: -"^[a-z]([-a-z0-9])*[a-z0-9]$"
    • changedInput schema / required
      Previous value: -[
      -  "org",
      -  "gvc",
      -  "workload"
      -]New value: +[
      +  "gvc",
      +  "workload"
      +]
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / additionalProperties
      Removed value: -false
    • changedOutput schema / properties / data / description
      Previous value: -"The full machine-readable result — list rows, the resource object, query results. Read THIS, not just the summary."New value: +"The full result. Read this, not only the summary."
    • addedOutput schema / properties / details
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / properties / nextSteps / description
      Removed value: -"Recommended follow-up actions for this task, in order."
    • removedOutput schema / properties / ok / description
      Removed value: -"Whether the call succeeded."
    • removedOutput schema / properties / summary / description
      Removed value: -"One-line summary of the result."
  3. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare read-only/idempotent, and the description adds behavior beyond them: waitSeconds polls server-side and returns latest state on timeout, the canonical endpoint must be reported as the public URL (never hand-built), and cron workloads expose per-execution history in status.jobExecutions. These are operational details an agent cannot infer from annotations.

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?

Every sentence carries actionable information: purpose, readiness framing, wait behavior, aggregate vs single-location, replica usage, cron history, and error routing. The most important guidance (primary readiness check, use waitSeconds) is front-loaded with no filler.

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?

With an output schema present, the description needn't explain return shapes, and it still supplies the interpretive guidance (canonical URL, replica values, jobExecutions location) an agent needs. Annotations fully cover the safety profile, so nothing material is missing.

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

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: it explains what omitting location yields (all locations + canonical URL), ties replica counts to the --replica flag for exec/connect/cp/port-forward, and clarifies the wait-or-timeout behavior of waitSeconds.

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?

States a specific verb and resource ('A workload's deployments: its per-location rollout status') and immediately frames it as the readiness check, distinguishing it from siblings like get_resource and diagnose_workload. An agent knows exactly what this returns without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names when to call it ('PRIMARY readiness check after create_workload/update_workload'), the alternative for failures ('A location that reports an error: diagnose_workload'), and how the optional location parameter selects between aggregate and single-deployment modes.

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.