pbs_apt_versions

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

With no annotations, the description carries the full burden. It labels the tool READ-ONLY, notes that the output shape is not live-verified, and explains that the API does not expose upgrade execution. However, it does not discuss authentication details beyond a cryptic reference to 'PROXIMO_PBS_* config', nor does it cover rate limits or potential errors.

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 somewhat verbose with 5 sentences, including redundant phrasing like 'Smoke-confirm: shape not live-verified — expected per-package dicts' which could be more direct. The last sentence about 'Needs PROXIMO_PBS_* config' is cryptic and adds minimal value without explanation.

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 (read-only, 2 params, output schema exists), the description covers purpose, output shape expectation, and behavioral constraints (no upgrade execution). It is mostly complete, though it could mention that the output schema provides definitive structure.

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%, so baseline is 3. The description adds context about the default value for 'node' and explains the 'proximo_target' parameter in terms of multi-target config, which is helpful beyond the schema itself.

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 clearly states the tool is READ-ONLY and retrieves installed versions of important Proxmox Backup Server packages on a PBS node. The verb 'get' and specific resource 'installed versions' are distinct from sibling tools like pbs_apt_updates_list and pbs_apt_changelog.

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 provides context about the output format and clarifies that the tool does not perform upgrades, but it lacks explicit guidance on when to use this tool versus siblings like pbs_apt_updates_list or pbs_apt_changelog. It implies usage but does not state alternatives.

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