Replace Workspace Variables

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

Annotations are all false, but description adds significant behavioral detail: soft-deletion of omitted variables, merge behavior for existing ids, and masking of sensitive returned values. These traits go well beyond what annotations disclose.

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

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

Three sentences, each packed with information: core action, behavior for omitted variables, behavior for existing ids, and output masking. No fluff, well-structured.

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

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

Despite having an output schema (not shown) and all-false annotations, the description covers the critical behaviors: replace-all scope, soft-delete, field merging, and sensitive masking. This is sufficient for an agent to understand and correctly invoke the tool.

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

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

Schema coverage is 0% and the description does not explain the variables array fields individually. It adds meaning for id (existing id merge) and isSecret (masking), but doesn't cover key, value, isEnabled, sortOrder, description. Partial compensation but not enough for zero coverage.

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

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

Specific verb 'Replaces' with resource 'complete workspace-global variable set'. Clearly distinguishes from sibling tools that handle individual variables (create/update/delete). The description's focus on the entire set makes the purpose unambiguous.

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

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

Implies usage for bulk replacement of the entire variable set, and clarifies that omitted variables are soft-deleted, which sets expectations. However, it doesn't explicitly mention alternatives or when not to use it, but the context is sufficient.

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