docs_catalog

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

Annotations already cover readOnly/openWorld/idempotent/non-destructive, so the bar is lower. The description still adds value by disclosing the network dependency ('Reaches the internet (the public DevDocs catalogue)') and the return payload shape, which the annotations do not convey.

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?

Front-loaded and well-sectioned with Args/Returns, but the trailing multilingual keyword block and the partial sentence fragment 'Reaches the internet (the public DevDocs catalogue)' before the Args section add noise that does not earn its place for an agent.

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?

No output schema exists, yet the description spells out the return shape ({results: [{slug, name, version, db_size_kb}], count, total, truncated}), so an agent knows exactly what it gets back before calling. Nothing material is missing for a two-param read-only listing tool.

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 carries the full burden and does: query is 'filter by name or slug' with concrete examples, and limit documents both the default (10) and the max (50), neither of which appears in 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?

States a specific verb+resource ('List downloadable offline docsets') and immediately names the sibling relationship ('Use before docs_install_docset'), letting an agent distinguish it from docs_search, docs_libraries, and docs_read without opening a schema.

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?

Explicitly states when to use it: 'Use before docs_install_docset to get the exact slug.' This names the downstream tool and the precondition, which is exactly the routing guidance an agent needs.

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