workspace_catalog

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

No annotations provided, so description carries full burden. Discloses that it returns dependency links and is token-efficient, implying read-only behavior. Does not discuss error conditions or authentication, but the concise scope is sufficient for a cataloging tool.

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 paragraphs, front-loaded with main purpose and then detail. Every sentence adds value; no wasted words. Highly concise and 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?

Covers return content (resources with links) and token efficiency. Has an output schema (though not shown) to define structure. Could mention limits or recursive dependencies, but for a simple catalog tool it is adequately complete.

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?

Input schema has no parameters, so baseline is 4. Description adds no parameter semantics because none exist, which is appropriate.

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?

Description clearly states it builds a 'relationship-aware catalog' of the workspace, listing specific resources (databases, datasets, charts, dashboards) with dependency links. Distinguishes from sibling snapshot_workspace by noting it is cheaper and returns only navigation fields.

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?

Explicit guidance to use before creating or updating resources to understand workspace topology. Mentions it is cheaper than snapshot_workspace, providing context for selection. Does not explicitly state when not to use or list other alternatives.

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