Skip to main content
Glama
Sign In

Dock

by ai.trydock
OverviewDiscussionsAdmin

update_workspace

Rename a workspace, change its slug, switch its default-view mode, or change its visibility (private | org). Pass any subset of name, new_slug, mode, visibility; fields you omit are left unchanged. Slug renames preserve old URLs via WorkspaceSlugAlias so previously-shared links keep resolving. Visibility flips disconnect every live SSE subscriber so reconnects re-authenticate against the new visibility. Editor role required; only the workspace owner can change visibility. Emits workspace.renamed and/or workspace.visibility_changed. Visibility WIDENING (private → org) is consent-gated: pass consent_mode: "web" to return an approval_url the user clicks; otherwise the call returns consent_required and you must re-issue with consent_mode set. Narrowing (org → private) and non-visibility updates execute immediately.

Input Schema

NameRequiredDescriptionDefault
modeNoNew default-view preference for the surface that opens first. Optional. Doesn't add or remove surfaces; use `create_surface` / `delete_surface` to change the actual surfaces.
nameNoNew display name. Optional.
slugYesThe current workspace slug
new_slugNoNew URL slug (lowercase kebab-case, 3-64 chars). Optional. Must be unique within the org. Old slug stays redirectable via the alias table.
visibilityNoNew visibility. Optional. `private` = explicit members only; `org` = every org member gets virtual editor. Only these two can be set. Widening (private → org) is consent-gated; see `consent_mode`.
consent_modeNoRequired when `visibility` widens audience. Pass 'web' to surface a click-to-approve URL the user opens in their browser; first call returns { status: 'approval_required', approval_url, polling_url }, you print approval_url in chat and poll polling_url for the result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / mode / description
      Previous value: -"New default-view preference for the workspace's first tab. Optional. Doesn't add or remove surfaces; use `create_surface` / `delete_surface` to change the actual tab set."New value: +"New default-view preference for the surface that opens first. Optional. Doesn't add or remove surfaces; use `create_surface` / `delete_surface` to change the actual surfaces."
    • changedInput schema / properties / visibility / description
      Previous value: -"New visibility. Optional. `private` = explicit members only; `org` = every org member gets virtual editor; `unlisted` = anyone with the URL can view; `public` = listed and viewable to all. Widening transitions are consent-gated; see `consent_mode`."New value: +"New visibility. Optional. `private` = explicit members only; `org` = every org member gets virtual editor. Only these two can be set. Widening (private → org) is consent-gated; see `consent_mode`."
    • changedInput schema / properties / visibility / enum
      Previous value: -[
-  "private",
-  "org",
-  "unlisted",
-  "public"
-]New value: +[
+  "private",
+  "org"
+]
  2. Changed1 schema field changed
    • changedInput schema / properties / mode / enum
      Previous value: -[
-  "table",
-  "doc"
-]New value: +[
+  "table",
+  "doc",
+  "html"
+]
  3. Changed1 schema field changed
    • changedInput schema / properties / mode / description
      Previous value: -"New default-view preference for the workspace's first tab. Optional. Doesn't add or remove surfaces — use `create_surface` / `delete_surface` to change the actual tab set."New value: +"New default-view preference for the workspace's first tab. Optional. Doesn't add or remove surfaces; use `create_surface` / `delete_surface` to change the actual tab set."
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so: it discloses that slug renames preserve old URLs via WorkspaceSlugAlias, that visibility flips disconnect every live SSE subscriber, that widening is consent-gated with a specific return shape (`consent_required`, then `approval_url` / `polling_url`), and that it emits `workspace.renamed` / `workspace.visibility_changed`. These are non-obvious side effects and auth requirements an agent cannot infer from the schema.

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 four mutatable fields, then progressively more specific caveats; every sentence carries operational information. It is dense but somewhat long, and the alias and consent mechanics are stated in both the description and the schema descriptions, producing minor redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter mutation tool with no output schema and no annotations, the description supplies the missing layers: side effects, privilege requirements, event emissions, and the two-step consent return contract. Nothing an agent needs in order to call it correctly, or to recover from a `consent_required` response, is absent.

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 100%, so the baseline is 3 and the schema already documents each field including enums. The description still adds meaning beyond the schema by explaining the widening-vs-narrowing asymmetry, the difference between consent-gated and immediate execution, and the role required to touch visibility, so it earns above baseline.

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 first sentence enumerates the exact mutations (rename, slug, mode, visibility) with a specific verb and resource, and the closing sentences scope it against siblings by pointing to `create_surface` / `delete_surface` for actual surface changes. An agent can distinguish this from `update_workspace_member` or `share_workspace` without opening another schema.

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

Usage Guidelines5/5

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

It states the partial-update contract ('Pass any subset... fields you omit are left unchanged'), the privilege gate (editor role; owner-only for visibility), and the precise condition for the alternative path (visibility widening requires `consent_mode: "web"`, narrowing does not). When-to-use and when-to-take-the-other-branch are both explicit.

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

All Dock toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources