quickshell_list_versions

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

With no annotations, the description carries the transparency burden. It discloses the live source, newest-first ordering, the latest-version reporting, and the in-process cache behavior with the refresh=True bypass. This gives the agent the key behavioral traits beyond the raw schema.

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?

Three short sentences, each earning its place: purpose/ordering/latest, usage context, and parameter clarification. No filler or repetition.

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 tool with one optional parameter and no output schema, the description is complete. It states what the return behavior is (list, newest first, latest identified) and how to control caching, which is all an agent needs to call it effectively.

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 only parameter, 'refresh', has no schema description, but the tool description fully explains its meaning: 'Set refresh=True to bypass the in-process cache.' The default false behavior is implied by the schema and the cache explanation, so the parameter is completely covered.

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 names a specific operation: list all Quickshell documentation versions from quickshell.org, ordered newest first, and identify the latest. This clear verb+resource phrase distinguishes it from siblings like quickshell_get_version and quickshell_get_page.

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?

It explicitly advises using this tool 'before fetching a page if you're unsure which version to use,' giving a concrete decision context. It does not name alternatives or exclusions, but the guidance is unambiguous enough for an agent to route correctly.

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