tracecat_list_workspaces

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

No annotations are provided, so the description must carry the full burden. It only states the tool lists workspaces but fails to disclose key behaviors such as return format, pagination, or whether the list is flat or hierarchical. The agent cannot infer the structure of the response.

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?

A single, front-loaded sentence conveys the tool's purpose with no extraneous words. It is appropriately concise for a zero-parameter tool.

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 no parameters, the tool lacks an output schema and the description gives no information about the return value (e.g., workspace IDs, names, or full objects). This leaves the agent uncertain about the output, making the description incomplete for a listing 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?

The tool has zero parameters, and the schema description coverage is 100%. According to guidelines, baseline 4 applies when no parameters exist, as there is no need for parameter description. The description does not add detail, but none is needed.

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 the tool lists workspaces accessible to the current user. It uses a specific verb 'list' and resource 'workspaces', and differentiates from sibling tools that list other entities like workflows or cases.

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 implies usage for listing workspaces but provides no guidance on when to use alternatives or when not to use it. Given the multitude of list tools, some context or exclusions would help, but the simplicity of zero parameters makes it less critical.

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