Skip to main content
Glama

list_deployments

Read-onlyIdempotent

List self-hosted Gateway deployments with status, type, default state, and connection health. Use before get, update, or archive actions to resolve a deployment ID; Enterprise plans 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.

Input Schema

TableJSON 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

TableJSON Schema
NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +}
  2. Addedv0.11.5

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, openWorld, and non-destructive, so the safety profile is covered. The description adds genuinely new behavioral context: the Enterprise gating and the 403 failure mode on non-Enterprise plans, plus a preview of what is returned. It does not discuss pagination or result limits, which is the remaining gap.

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 with purpose and routing in three tight sentences with no filler. However, 'Enterprise-gated' is stated twice (opening and closing sentence), which is redundant and costs a little efficiency.

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 a full input schema, an output schema, and rich annotations, the description only needs to add gating and routing — both present. It is nearly complete; only pagination/result-set behavior for a potentially large listing tool is unaddressed.

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%, and all six filters (tags, type, search, status, workspace_slug, organisation_id) are documented in the schema, including two enums. The description adds no additional filter semantics or combination rules, so the baseline 3 applies.

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 resource (registered self-hosted Gateway deployments) and enumerates the returned attributes (status, type, default state, connection health). It is clearly distinguishable from get_deployment/update_deployment/archive_deployment, which it names directly.

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?

Gives an explicit usage rule: call this before get_deployment, update_deployment, or archive_deployment to resolve a deployment ID. It also names the plan-level precondition (Enterprise-gated, 403 otherwise), so the agent knows both when to use it and when it will fail.

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