portkey-admin-mcp

list_deployments

Read-onlyIdempotent

Retrieve registered self-hosted Gateway deployments with status, type, and connection health. Use it to resolve deployment IDs before updating or archiving deployments.

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

Name	Required	Description
`type`	No	Filter by deployment type
`search`	No	Search deployment names
`status`	No	Filter by deployment status
`workspace_slug`	No	Filter by one or more workspace slugs
`organisation_id`	No	Filter by organisation UUID

Output Schema

TableJSON Schema

Name	Required	Description
`ok`	Yes	Whether the tool call succeeded and returned structured data
`data`	No	Structured success payload when ok is true
`error`	No	Structured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

Addedv0.11.5Sep 8, 2026

TDQS

A4.5/5.0

Behavior5/5

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

Annotations already indicate a safe, idempotent read operation, and the description adds meaningful behavioral context: it is Enterprise-gated and returns 403 on non-Enterprise plans, plus it enumerates the returned fields. No contradiction with annotations exists.

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

Conciseness3/5

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

The content is useful and front-loaded, but 'Enterprise-gated.' is repeated twice, which is redundant. Tightening the description by removing the duplication would make it more concise.

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?

The description covers purpose, usage context, access restrictions, error behavior, and key output fields. With an output schema present and rich annotations, nothing critical is missing for an agent to invoke this tool correctly.

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%, so the parameters are already well documented. The description does not add additional meaning about parameter usage beyond what the schema provides, which is expected but keeps this dimension at the baseline.

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 clearly states the operation: listing registered self-hosted Gateway deployments and the specific fields returned. It also distinguishes itself from get_deployment, update_deployment, and archive_deployment by positioning this as the ID-resolution step.

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 instructs to use this tool before get_deployment, update_deployment, or archive_deployment to resolve a deployment ID. It also discloses the Enterprise plan requirement and the 403 failure mode, giving clear conditions for appropriate use.

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

Deploy Server