List Workspace Tree

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

Description discloses that the tool loads all documents and may be slow, implying it is a read operation. Without annotations, it adds value by warning about performance, but it does not specify error handling, authorization needs, or the exact structure of the returned tree.

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 short sentences: purpose, usage tip, performance warning. No unnecessary words, front-loaded core information. Every sentence adds unique value.

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 a clear purpose, the description lacks details on return format (beyond tree levels), error handling, required permissions, and whether workspaceId is optional. Given no output schema and complexity, more completeness is needed.

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 50% (depth only). The description repeats the depth parameter's purpose and default but completely omits workspaceId. With low coverage, the description should compensate but fails to add meaning for workspaceId.

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 returns the full document hierarchy as a tree (roots → children → grandchildren), which distinguishes it from sibling tools like list_docs (flat list) or list_children (direct children only). The verb 'returns' and resource 'document hierarchy' are specific and 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?

Description advises using the depth parameter and warns about performance on large workspaces. However, it does not explicitly state when to use this tool versus alternatives (e.g., list_children for targeted queries) or when not to use it.

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