Well

Update workspace category

well_update_workspace_category

Update one workspace tag. Only an owner or administrator can manage workspace tags. This never edits a shared company or transaction catalog. Linked tags must be detached before renaming or deletion; child tags must be removed first. Use category_id from well_query_records on categories.

Input Schema

Name	Required	Description
`name`	Yes
`category_id`	Yes
`workspaceId`	No
`workspace_id`	No	Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
`conversation_id`	No	The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
`idempotency_key`	No	Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
`workspace_scope`	No	Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.

Output Schema

Name	Required	Description
`code`	No
`data`	No
`error`	No
`success`	Yes
`reply_lines`	No
`conversation_id`	No	The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
`near_candidates`	No
`newly_connected`	No	Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
`conversation_id_note`	No	Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.
`conversation_id_source`	No	Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.
`near_candidates_truncated`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedOct 28, 2026

addedOutput schema / properties / code
```
Added value: +{
+  "type": "string"
+}
```

addedOutput schema / properties / near_candidates

Added value: +{
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "company_id": {
+        "type": "string"
+      },
+      "name": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "company_id",
+      "name"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

addedOutput schema / properties / near_candidates_truncated
```
Added value: +{
+  "type": "boolean"
+}
```

addedOutput schema / properties / reply_lines

Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

AddedOct 21, 2026

TDQS

A4/5.0

Behavior4/5

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

Annotations only say readOnly=false, destructive=false, openWorld=false; the description adds genuinely new behavior: authorization level required, the linkage/child-tag prerequisites that will block the call, and a scope guarantee that shared company and transaction catalogs are never edited. It does not disclose what happens to the tag's existing assignments on rename or whether the change is reversible.

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?

Four short sentences, front-loaded with purpose then permissions then preconditions then the id-source hint; almost no filler. The clause "before renaming or deletion" drags deletion into a rename-only tool and briefly muddies scope, which is the only real waste.

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?

An output schema exists, so return values need not be described, and the annotations already cover the safety profile. Given that, the description supplies everything an agent needs to call it correctly: authorization, blocking preconditions, the source of category_id, and the fact that it will not mutate shared catalogs.

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 57%, with workspace_id, conversation_id, idempotency_key and workspace_scope all self-documented in the schema. The description only adds provenance for category_id (fetch from well_query_records on categories) and says nothing about the required `name` parameter, which the schema leaves entirely undocumented — so the agent must infer that `name` is the new tag name.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence pairs a specific verb with a specific resource ("Update one workspace tag") and a second sentence bounds the blast radius by stating what it never touches (shared company or transaction catalog). It is clearly separable from well_create_workspace_category and well_delete_workspace_category, though it never names those siblings or the closely related well_update_workspace_category_override.

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 permission gate ("Only an owner or administrator can manage workspace tags"), two preconditions (detach linked tags, remove child tags first), and routes the agent to well_query_records for the category_id. What is missing is a stated alternative when the caller lacks the owner/admin role or when the tag is linked, since no fallback tool is named.

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

All Well tools Inspect

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

Need Help?