pve_apt_changelog

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

With no annotations, the description provides key behavioral details: the tool is read-only, the returned text is untrusted (adversarial classification), and the API response shape is not live-verified ('Smoke-confirm'). It also clarifies that upgrades are not executed via this tool. Lacks information on authentication or error handling, but overall strong transparency.

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?

Every sentence contributes meaningful information. The description is well-structured: starts with purpose and read-only flag, then endpoint, then security classification, then a note about upgrades. No redundant or filler text.

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 read-only tool with 4 parameters and an existing output schema, the description covers all essential aspects: purpose, endpoint, parameter context, behavioral notes, and security classification. Nothing critical is missing.

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 covers all 4 parameters with descriptions (100% coverage). The description adds value by showing the actual API endpoint pattern, noting default behavior for 'node', and providing an example for 'name' (linked to pve_apt_updates_list). This enhances understanding beyond the schema alone.

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 action ('get a package's changelog text') and resource ('on a PVE node'), immediately establishes READ-ONLY nature, and distinguishes from siblings by noting this is one of seven pve_apt_* tools and that the content is adversarial unlike the others.

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 explains when to use the tool (to view changelog text), notes the output is upstream-authored and thus adversarial, and clarifies that upgrades are not performed through the API—only visibility. It does not explicitly compare with sibling tools like pve_apt_updates_list, but the context is sufficient for an AI agent.

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