list_diagrams

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

The annotations already declare read-only, idempotent, and non-destructive behavior, so the description's job is lighter. It adds valuable context about stable ordering and pagination mechanics, going beyond what annotations provide. Does not contradict annotations.

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 sentence that starts with the core purpose, then compactly provides return structure and pagination instruction. No wasted words; everything is essential and immediately useful.

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?

For a read-only list operation, the description covers the result format, pagination logic, and ordering guarantee. The output schema (if present) is not shown, but the description explicitly lists the response fields, making it self-contained. No missing information that an agent would need to call 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?

Schema coverage is 100% for both parameters (limit, offset), but the description enhances understanding by explaining offset in the context of 'stable filename order' and pagination, which is not fully captured by the schema. This adds functional meaning beyond parameter names and defaults.

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 clear verb ('List') and resource ('diagrams') with the specific ordering definition ('stable filename order'). It also specifies the return shape, making it unambiguous what the tool does and how it differs from other diagram operations like open, save, or export.

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?

Provides explicit pagination usage ('request the next page with offset + returnedCount') which is key to correct invocation. It doesn't explicitly mention when not to use this tool, but no direct alternative exists among siblings for listing diagrams, so the guidance is sufficient for the use case.

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