portkey-admin-mcp

update_workspace

Modify a workspace's name, slug, description, default status, metadata, limits, guardrails, or API key config by ID; only supplied fields change and changes apply immediately.

Instructions

Update a workspace's name, slug, description, default flag, or metadata by id, unlike update_workspace_member which changes role assignments within a workspace. Only provided fields change and updates take effect immediately; changing the slug can break URLs, API key references, and other external links, so confirm no dependencies first.

Input Schema

Name	Required	Description
`name`	No	New name for the workspace
`slug`	No	New slug for the workspace
`metadata`	No	New metadata key-value pairs
`is_default`	No	Set as default workspace (1 = yes, 0 = no)
`description`	No	New description
`rate_limits`	No	Replacement workspace rate-limit settings
`usage_limits`	No	Replacement workspace usage-limit settings
`workspace_id`	Yes	The workspace ID to update
`input_guardrails`	No	Guardrail IDs applied to workspace model inputs
`output_guardrails`	No	Guardrail IDs applied to workspace model outputs
`user_api_key_config`	No	Default config slug for workspace-user API keys, or null to clear

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.

Changed1 schema field changedv1.0.11Oct 30, 2026
- addedInput schema / properties / workspace_id / minLength
```
Added value: +1
```

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"

Changed3 schema fields changedv0.12.2Oct 2, 2026

changedInput schema / properties / usage_limits / items / properties / next_usage_reset_at / anyOf

Previous value: -[
-  {
-    "format": "date-time",
-    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "format": "date-time",
+    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

removedInput schema / properties / user_api_key_config / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / user_api_key_config / type
```
Added value: +[
+  "string",
+  "null"
+]
```

Changed5 schema fields changedv0.11.5Sep 8, 2026

addedInput schema / properties / input_guardrails

Added value: +{
+  "description": "Guardrail IDs applied to workspace model inputs",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

addedInput schema / properties / output_guardrails

Added value: +{
+  "description": "Guardrail IDs applied to workspace model outputs",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

addedInput schema / properties / rate_limits

Added value: +{
+  "description": "Replacement workspace rate-limit settings",
+  "items": {
+    "properties": {
+      "type": {
+        "description": "Whether the limit counts requests or tokens",
+        "enum": [
+          "requests",
+          "tokens"
+        ],
+        "type": "string"
+      },
+      "unit": {
+        "description": "Rate window: requests per day, hour, or minute",
+        "enum": [
+          "rpd",
+          "rph",
+          "rpm"
+        ],
+        "type": "string"
+      },
+      "value": {
+        "description": "Maximum count in the selected rate window",
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}

addedInput schema / properties / usage_limits

Added value: +{
+  "description": "Replacement workspace usage-limit settings",
+  "items": {
+    "properties": {
+      "alert_threshold": {
+        "description": "Percentage of the limit that triggers an alert",
+        "exclusiveMinimum": 0,
+        "type": "number"
+      },
+      "credit_limit": {
+        "description": "Maximum cost or token usage for the workspace",
+        "exclusiveMinimum": 0,
+        "type": "number"
+      },
+      "next_usage_reset_at": {
+        "anyOf": [
+          {
+            "format": "date-time",
+            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Next reset timestamp in ISO 8601 format"
+      },
+      "periodic_reset": {
+        "anyOf": [
+          {
+            "enum": [
+              "monthly",
+              "weekly"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Built-in weekly or monthly reset cadence"
+      },
+      "periodic_reset_days": {
+        "anyOf": [
+          {
+            "maximum": 365,
+            "minimum": 1,
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Custom reset cadence in days, from 1 through 365"
+      },
+      "type": {
+        "description": "Whether the limit measures cost or tokens",
+        "enum": [
+          "cost",
+          "tokens"
+        ],
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}

addedInput schema / properties / user_api_key_config

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Default config slug for workspace-user API keys, or null to clear"
+}

Addedv1.0.1May 7, 2026
RemovedMay 1, 2026
First observedJan 1, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already declare non-readonly, non-destructive, non-idempotent, open-world. The description adds genuine value beyond that: partial-update semantics ('only provided fields change'), immediate effect, and a concrete risk disclosure for slug changes (broken URLs, API key references, external links). Minor gap: the schema's rate_limits/usage_limits arrays are 'replacement' settings, which the 'only provided fields change' phrasing could obscure.

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 core action, then sibling contrast, then the caution. Two dense sentences with no filler; only the field list is arguably redundant given the schema.

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 not be explained, and the schema fully documents the nested rate/usage limit objects. For an 11-param mutation tool the description is adequately complete, though it could have acknowledged the replacement behavior of the limit arrays.

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 schema documents all 11 parameters fully. The description enumerates only 5 of the optional fields (name, slug, description, default flag, metadata) and omits rate_limits, usage_limits, guardrails, and user_api_key_config, so it adds little beyond the baseline provided by the schema.

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 workspace's name, slug, description, default flag, metadata) keyed by id, and explicitly names the sibling it is not (update_workspace_member). An agent can distinguish it from the member-update tool without opening either 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?

Names the alternative tool and the condition that selects it (role assignment changes), and adds a clear precondition warning to verify dependencies before changing the slug. It stops short of spelling out when to use this tool generally versus e.g. update_rate_limit/update_usage_limit for the nested limit fields, but the contrast guidance is solid.

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

Deploy Server