list_diagrams

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

With no annotations, the description carries the burden. The verb 'List' implies a read-only operation, but the description does not explicitly state non-destructiveness or disclose any side effects. It also leaves the term 'managed-link state' unexplained, which could be important behavioral context. Overall, it is adequate but lacks detail.

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?

The description is a single, efficient sentence that conveys the essential information without any fluff. Every word contributes to understanding what the tool does.

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?

This is a simple listing tool with one parameter and an output schema (which is present). The description explains the purpose and scope adequately. It could mention read-only behavior explicitly, but the verb 'List' and the presence of the output schema make the tool fairly complete for an agent to use.

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 input schema already fully describes the only parameter (document) with its own description. The tool description adds no extra meaning about the parameter, so the baseline of 3 applies. It neither enhances nor detracts from the schema.

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's action (List), the resource (Mermaid blocks and their managed-link state), and the scope (one Markdown document). It is specific and distinguishes this from siblings like open_diagram and sync_document, which imply different actions.

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 gives clear context: this tool is used to list diagrams in a specific document, which implies when to use it. However, it does not explicitly mention alternatives or exclusions (e.g., 'use open_diagram to view a diagram') or when not to use it. The sibling names help but are not referenced.

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