portkey-admin-mcp

update_deployment

Update a registered Gateway deployment's settings, workspace or JWT-sub access rules, or rotate its authentication secret; inspect current settings first.

Instructions

Enterprise-gated. Update a registered Gateway deployment, its workspace or JWT-sub access, or rotate its authentication secret. Use get_deployment first to inspect current settings. Rotation returns the new secret once in this MCP transcript, so store it securely immediately. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

Name	Required	Description
`id`	Yes	Deployment UUID
`name`	No	Replacement display name
`tags`	No	Replacement deployment tags, or null to clear all tags
`type`	No	Replacement deployment type
`status`	No	Replacement deployment status
`is_default`	No	Whether this is the default deployment
`rotate_auth`	No	Rotate the one-time deployment authentication secret
`gateway_base_url`	No	Self-hosted Gateway base URL
`jwt_subs_allowed`	No	JWT subject values allowed to use the deployment
`deployment_config`	No	Replacement Gateway configuration, or null to clear it
`override_existing`	No	Allow replacement of existing deployment settings
`workspaces_allowed`	No	Workspace slugs this deployment may serve; empty allows all
`remove_subs_allowed`	No	JWT subject values to remove from the allowlist
`allow_all_workspaces`	No	Clear workspace restrictions and allow every workspace
`mcp_gateway_base_url`	No	MCP Gateway base URL
`is_dataservice_hosted`	No	Whether the deployment hosts its own data service
`jwt_sub_workspace_mapping`	No	JWT subject to workspace-slug mapping
`remove_workspaces_allowed`	No	Workspace slugs to remove from the allowlist
`is_playground_proxy_allowed`	No	Whether Playground proxy traffic is allowed

Output 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.

Changed2 schema fields changedv1.0.9Oct 26, 2026

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"

Changed1 schema field changedv0.12.2Oct 2, 2026

addedInput schema / properties / tags

Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": {
+        "type": "string"
+      },
+      "propertyNames": {
+        "pattern": "^[a-zA-Z0-9_-]+$",
+        "type": "string"
+      },
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Replacement deployment tags, or null to clear all tags"
+}

Addedv0.11.5Sep 8, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Adds real context beyond the annotations: an Enterprise-only gate that returns 403 on non-Enterprise plans, and the one-time nature of the rotated secret that must be stored immediately. This is valuable since idempotentHint=false and destructiveHint=false don't convey that rotation invalidates the prior secret or that the new secret is shown exactly once.

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-loads the gate and the core purpose, and every sentence carries operational meaning. The duplicated 'Enterprise-gated.' at the start and end is redundant waste that keeps it off a 5.

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?

For a 19-parameter mutation with an output schema and rich annotations, the description covers the two things an agent can't infer: the Enterprise 403 gate and the irrecoverable one-time secret return. It stops short of noting interactions like override_existing or allow_all_workspaces overriding other params, but nothing critical for correct invocation is missing.

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 per-parameter meaning is already documented (including the null-to-clear semantics for tags and deployment_config). The description only names the high-level edit categories rather than adding format or interaction rules, which is the expected baseline when the schema does the heavy lifting.

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 ('Update a registered Gateway deployment') plus the concrete mutation surfaces: workspace access, JWT-sub access, and secret rotation. This clearly separates it from register_deployment, get_deployment, and archive_deployment in the sibling list.

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 tells the agent to call get_deployment first to inspect current settings, which is actionable sequencing guidance. It does not, however, say when to prefer archive_deployment (status change) or when update is inappropriate versus those siblings.

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

Deploy Server