Skip to main content
Glama

update_deployment

Destructive

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

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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
idYesDeployment UUID
nameNoReplacement display name
tagsNoReplacement deployment tags, or null to clear all tags
typeNoReplacement deployment type
statusNoReplacement deployment status
is_defaultNoWhether this is the default deployment
rotate_authNoRotate the one-time deployment authentication secret
gateway_base_urlNoSelf-hosted Gateway base URL
jwt_subs_allowedNoJWT subject values allowed to use the deployment
deployment_configNoReplacement Gateway configuration, or null to clear it
override_existingNoAllow replacement of existing deployment settings
workspaces_allowedNoWorkspace slugs this deployment may serve; empty allows all
remove_subs_allowedNoJWT subject values to remove from the allowlist
allow_all_workspacesNoClear workspace restrictions and allow every workspace
mcp_gateway_base_urlNoMCP Gateway base URL
is_dataservice_hostedNoWhether the deployment hosts its own data service
jwt_sub_workspace_mappingNoJWT subject to workspace-slug mapping
remove_workspaces_allowedNoWorkspace slugs to remove from the allowlist
is_playground_proxy_allowedNoWhether Playground proxy traffic is allowed

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: +{
      +  "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"
      +}
  4. Addedv0.11.5

TDQS

A4.3/5.0
Behavior5/5

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

The annotations already flag destructive, non-idempotent, open-world behavior, but the description adds the two facts an agent cannot infer elsewhere: the operation is unreachable on non-Enterprise plans (403), and auth rotation reveals the new secret exactly once, so it must be persisted immediately. The one-time-secret disclosure is exactly the kind of irreversible consequence an agent needs before calling.

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?

The gating constraint and the get_deployment prerequisite are front-loaded, and the secret-handling warning is placed at the point of risk. However, 'Enterprise-gated.' appears twice in four sentences, and the trailing 'Returns 403 on non-Enterprise Portkey plans' repeats the same point a third time, which is wasted space.

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 destructive mutation with rich annotations and an output schema, the description supplies the plan-gating constraint, the inspect-first workflow, and secret-return semantics, which are the high-risk gaps. It leaves replacement-versus-merge behavior and the role of override_existing to the schema, which is acceptable given full schema coverage.

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 every one of the 19 parameters is already documented individually. The description contributes only loose groupings ('workspace or JWT-sub access', 'rotate its authentication secret'), which help the agent orient but add no format, defaulting, or conflict-resolution detail 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?

The description uses a specific verb-plus-resource ('Update a registered Gateway deployment') and then enumerates the three distinct mutation domains it covers: deployment settings, workspace/JWT-sub access, and auth-secret rotation. This is enough to tell it apart from register_deployment and archive_deployment without opening any schema.

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?

It gives an explicit prerequisite workflow: 'Use get_deployment first to inspect current settings.' That meaningfully steers tool ordering. It stops short of naming when to prefer a sibling (e.g. archive_deployment for archiving or update_access_policy for policy work), so it is clear context rather than full routing.

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