Skip to main content
Glama

Update workspace

workspace_update
DestructiveIdempotent

Update workspace metadata: name, description (null clears), or both. Workspace administrators only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
whyNoRequired for workspace items: one sentence on what the person is trying to accomplish, in their terms, not a description of this edit. Every workspace write takes one; sessions and summaries record themselves from it. At most 300 characters.
nameNo
descriptionNo
workspaceIdYesThe workspace id (UUID).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and readOnlyHint=false, so the safety bar is lower; the description still earns credit by explaining the actual destructive semantic ('null clears' the description) and the admin-only authorization requirement, neither of which is derivable from annotations. It stops short of saying whether omitted fields are left untouched or whether name/description are replaced wholesale.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the mutability scope and followed by the permission gate. Every clause carries information an agent needs; nothing is padding.

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 annotations plus the description together cover mutability and authorization. What remains unstated is whether name and description are optional/partial (only workspaceId is required) and the partial-vs-replace semantics for omitted fields.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50% and the description supplies the missing meaning for the `description` parameter: the schema only says the type is string-or-null, while the description explains that null clears the field. It says nothing about the required `why` parameter, but the schema's own description there is thorough, so the gap is small.

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 (update) and resource (workspace metadata) plus the exact mutable fields (name, description), which cleanly separates it from workspace_create, workspace_delete, and workspace_member_set_role in the sibling list. An agent can tell instantly what this tool changes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Adds a real prerequisite ('Workspace administrators only') but gives no guidance on alternatives (e.g., workspace_show to read current values, or workspace_delete for removal) and no explicit when-not conditions. Usage is inferable but not routed.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.