list_doc_versions

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

The description mentions it 'Queries the ReadTheDocs API to discover published versions,' indicating a network call. No annotations are provided, so the burden is on the description. It does not disclose potential side effects, authentication needs, or rate limits, but as a read-only list operation, this is moderately acceptable.

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 extremely concise: two sentences plus an Args block. It front-loads the purpose, then adds usage context and parameter guidance. Every sentence serves a distinct purpose without 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?

Given the tool's simplicity (one parameter, output schema exists), the description adequately covers the core function and usage context. It lacks details on error cases or network dependencies, but it is sufficient for an agent to select and invoke the tool correctly in most scenarios.

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 contains only the 'package' parameter with no description. The description adds 'Package name as returned by list_packages().' This provides a helpful source hint, guiding the agent to use the correct value format. Schema coverage is 0%, so this compensation is valuable.

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 begins with 'List all available documentation versions for a package,' which is a specific verb+resource combination. It further distinguishes the tool by stating it should be called before get_doc_section or search_docs for non-latest versions, showing its unique prerequisite role among siblings.

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 explicitly states 'Always call this before get_doc_section or search_docs when the user asks about a specific version other than the latest.' This gives clear when-to-use guidance. It does not mention when not to use it, such as for the latest version, but the context implies alternatives.

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