List Workspace Variables

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

Annotations already declare read-only and idempotent behavior. The description adds valuable info about masking secret variables and sensitive keys, which is not covered by annotations. This improves transparency about the tool's output handling.

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?

Two concise sentences provide the core purpose and one key behavior (masking). No fluff or irrelevant details.

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?

Given the simple read-only operation and presence of an output schema, the description is adequate but lacks param semantics (e.g., whether workspaceId is optional, default behavior) and does not describe any pagination or grander behavior. It covers the essentials but leaves some gaps.

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 description coverage is 0% and the description does not explain the 'workspaceId' parameter at all. While not required, its purpose is unclear beyond the implied workspace context, leaving the agent to guess whether it is mandatory or how to format it.

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?

The description clearly states it lists workspace-global variables, using a specific verb and resource scope. It distinguishes from sibling tools like unfour.workspace.create_variable or delete_variable, and clarifies it operates on workspace-level data.

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?

The description mentions the scope (workspace-global) but does not explicitly contrast with alternatives or state when to use this tool versus other list tools (e.g., connection lists). It gives enough context via the name and scope, but lacks explicit guidance on alternatives.

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