Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_deployments

Read-onlyIdempotent

List self-hosted Gateway deployments with status, type, and connection health to resolve a deployment ID before get, update, or archive operations. Returns 403 on non-Enterprise Portkey plans.

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

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
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. 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"
  2. 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"
+}
  3. 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 readOnlyHint=true and destructiveHint=false, yet the description still adds real behavioral value: the Enterprise plan gate and the concrete 403 failure mode on non-Enterprise plans. It omits pagination/result-size behavior, but no paging parameters exist so the gap is small.

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 the gating constraint and the sibling-routing rule in two tight sentences. Minor waste: 'Enterprise-gated.' appears twice, once at the head and again before the 403 sentence.

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?

Output schema exists so return values need no explanation, and the schema plus annotations cover parameters and safety. Description completes the picture with plan gating and downstream usage, leaving only result volume/pagination 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% with two enum-constrained filters, so the schema fully documents tags, type, search, status, workspace_slug, and organisation_id. The description mentions returned attributes but adds no filtering syntax or semantics beyond the schema; 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 and resource ('List registered self-hosted Gateway deployments') plus the fields returned, and the self-hosted Gateway scope distinguishes it from generic list tools like list_workspaces or list_integrations.

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 routes the agent: use this to resolve a deployment ID before calling get_deployment, update_deployment, or archive_deployment. Names the alternatives but does not state any when-not-to-use condition or note that the three sibling tools also accept names/slugs.

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