list_topics

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

With no annotations, the description carries the full burden. It clearly states the read-only list behavior and optional filtering, but does not disclose return format, pagination, or whether filters combine. It is minimally transparent but lacks deeper behavioral context.

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, front-loaded sentence that directly states the action and scope. Every word adds value, with no filler or redundancy.

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 simple list tool, the description covers purpose and filters adequately, but without an output schema it does not explain return values or the relationship between filters (e.g., whether they can be combined). This leaves some ambiguity for an agent deciding if this tool meets its needs.

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 0%, so the description must compensate. It does so by naming both parameters ('product' and 'topic type') and explaining their role as optional filters, adding meaning beyond the raw enums. It does not detail enum semantics, but the schema already provides those.

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 uses a specific verb ('List') and a clear resource ('all available documentation topics'), and explicitly mentions optional filters. This distinguishes it from sibling tools like search_docs (searching) and get_topic (fetching a specific topic).

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 implies usage (browsing available topics with optional filters) but does not explicitly state when to prefer this over alternatives or mention exclusions. It provides clear context for the list action but lacks explicit when-to-use versus search_docs or get_topic guidance.

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