pve_agent_set_password

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

Discloses that password is unconditionally redacted from the ledger, no undo primitive, and that the endpoint/body fields are unverified. No annotations exist, so the description fully informs about risks and side effects.

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?

Concise, using a structured layout with bold leading label and bullet points. Every sentence adds value; no fluff.

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?

Covers key behavioral aspects (dry-run, redaction, no undo, prerequisites) despite missing detailed param descriptions. Output schema likely covers return values, so overall adequate.

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 only 17%. The description adds meaning to confirm and password but doesn't describe node, vmid, or username beyond their schema titles. Partial compensation but not complete.

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 'MUTATION: set a guest OS user'’s password via the qemu-agent.' This is a specific verb-resource combination, differentiating it from sibling tools like pve_agent_exec or pve_agent_file_read.

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 explains the dry-run pattern and the need for confirm=True to execute, plus prerequisites (PROXIMO_ENABLE_AGENT=1, VMID in allowlist). It doesn't explicitly state when not to use it but the guidance is clear.

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