Skip to main content
Glama

update_workspace

Destructive

Modify an existing workspace's name, slug, description, default status, metadata, rate limits, usage limits, or guardrails by ID; only supplied fields change 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.

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": {
      "workspace_id": "<workspace_id>"
    },
    "name": "update_workspace"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name for the workspace
slugNoNew slug for the workspace
metadataNoNew metadata key-value pairs
is_defaultNoSet as default workspace (1 = yes, 0 = no)
descriptionNoNew description
rate_limitsNoReplacement workspace rate-limit settings
usage_limitsNoReplacement workspace usage-limit settings
workspace_idYesThe workspace ID to update
input_guardrailsNoGuardrail IDs applied to workspace model inputs
output_guardrailsNoGuardrail IDs applied to workspace model outputs
user_api_key_configNoDefault config slug for workspace-user API keys, or null to clear

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. Changed1 schema field changedv1.0.11
    • addedInput schema / properties / workspace_id / minLength
      Added value: +1
  3. 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"
  4. Changed3 schema fields changedv0.12.2
    • 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"
      +]
  5. Changed5 schema fields changedv0.11.5
    • 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"
      +}
  6. Addedv1.0.1
  7. Removed
  8. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and openWorldHint=true, and the description meaningfully builds on that: it discloses partial-update semantics ('only provided fields change'), immediacy of effect, and specifically that slug changes break URLs, API key references, and external links. Missing are permission/auth requirements and any reversibility guidance, so it stops short of a 5.

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?

Two sentences, front-loaded with the field list and the sibling distinction, then the risk caveat. The field enumeration is slightly padded since the schema already lists them, but nothing is wasted.

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 an 11-parameter, nested-object mutation tool with an output schema, the description covers the core semantics, partial-update behavior, and the highest-risk field. The omission of the limit/guardrail arrays is mitigated by their thorough schema descriptions.

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 parameters are already documented; the description only enumerates a subset (name, slug, description, default flag, metadata) and omits rate_limits, usage_limits, guardrails, and user_api_key_config. Its only real value-add is the slug risk warning, so 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 ('Update a workspace's name, slug, description, default flag, or metadata by id') and explicitly contrasts with the sibling update_workspace_member. An agent can distinguish the two 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 closest alternative (update_workspace_member) and what it does instead, plus a concrete pre-condition ('confirm no dependencies first' before a slug change). It does not cover other workspace-level alternatives like delete_workspace or get_workspace, but the guidance is clear and actionable.

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