List workspaces

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

Annotations only declare readOnlyHint, so the description usefully adds that an API key yields exactly one workspace while an OAuth token yields the granted workspaces still matching the user's membership. It also names the downstream header mechanism (X-Orchestra-Account-Id), which is real behavioral context beyond the annotation.

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 short paragraphs, scoping behavior front-loaded ahead of the downstream usage note. Every sentence carries information and none is redundant.

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?

An output schema exists, so return-value structure needn't be re-explained. Combined with the annotation and the credential-dependent scope plus follow-up usage guidance, an agent has everything needed to call and use this tool correctly.

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?

There are zero input parameters, so the baseline is 4. The description adds meaningful semantic context by clarifying that a returned id is the selector used on workspace-scoped calls, tying the output back to how it is consumed.

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 states a specific verb and resource ('Lists the workspaces this credential can act on') and precisely distinguishes how the result set varies by credential type (API key vs OAuth). No sibling tool lists accounts, and the scope is 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?

It explains the when and why clearly through the credential-type behavior and tells the agent what to do with the result ('Pass a returned id to select the workspace...'). There is no explicit comparison to an alternative, though no analogous sibling exists to route away from.

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