Skip to main content
Glama

list_deployments

Read-onlyIdempotent

Lists registered self-hosted Gateway deployments with status, type, default state, and connection health so you can resolve IDs for viewing, updating, or archiving. Enterprise-only.

Instructions

Enterprise-gated. List registered self-hosted Gateway deployments with status, type, default state, and connection health. Use this before get_deployment, update_deployment, or archive_deployment to resolve a deployment ID. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_deployments"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagsNoMatch deployments with all supplied tags
typeNoFilter by deployment type
searchNoSearch deployment names
statusNoFilter by deployment status
workspace_slugNoFilter by one or more workspace slugs
organisation_idNoFilter by organisation UUID

Output Schema

NameRequiredDescriptionDefault
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Changed1 schema field changedv0.12.2
    • addedInput schema / properties / tags
      Added value: +{
      +  "additionalProperties": {
      +    "type": "string"
      +  },
      +  "description": "Match deployments with all supplied tags",
      +  "propertyNames": {
      +    "pattern": "^[a-zA-Z0-9_-]+$",
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
  4. Addedv0.11.5

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world behavior, so the description's added value lies in the Enterprise plan gating and the specific failure mode (403 on non-Enterprise Portkey plans). This is genuinely non-obvious context an agent needs before calling. It doesn't cover result-set size or ordering, but no pagination parameters exist.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded and tight, but 'Enterprise-gated.' appears twice, once at the start and once again in the final sentence, which is redundant wording that could be merged. The usage guidance sentence is well placed in the middle.

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?

With an output schema present, return values need not be explained, and annotations cover the safety profile; the gating prerequisite is the one non-obvious item and it is stated. A minor gap remains on whether results are paginated or bounded, though no pagination parameters exist to document.

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 100% with enums documented for type and status, so the schema carries the parameter burden. The description only mirrors the filterable concepts by naming returned fields, adding no format or combination guidance beyond the schema.

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 (List) and a precisely scoped resource (registered self-hosted Gateway deployments), and enumerates the fields returned (status, type, default state, connection health). This distinguishes it from get_deployment/update_deployment, which operate on a single deployment.

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?

Explicitly says to call this before get_deployment, update_deployment, or archive_deployment to resolve a deployment ID, which is concrete workflow guidance. It lacks an explicit when-not, but the read-only listing scope versus single-resource siblings is clear from context.

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

Deploy Server

Other Tools