proxmox_agent_user

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

No annotations are provided, so the description carries the full burden. It adds the requirement for elevated permissions, which is useful, but does not disclose other behavioral traits such as whether the change is immediate, reversible, or affects running processes.

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 consists of two concise sentences, front-loading the core purpose and adding a key requirement. Every word earns its place with no 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 complexity of the tool (6 parameters, single operation, many sibling tools), the description is adequate but lacks information about prerequisites (e.g., QEMU agent installed and running) and return values (no output schema). It provides enough context for basic use but leaves gaps.

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 83%, so the schema already documents most parameters. The description adds no additional parameter context beyond the schema; it only restates the operation enum value. Baseline score 3 is appropriate.

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 indicates the tool manages guest users via QEMU agent and specifies the operation 'set_password'. While it differentiates from sibling agent tools (e.g., exec, file) by focusing on user management, it could be more precise by explicitly stating that it only sets passwords.

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 mentions 'requires elevated permissions' but provides no guidance on when to use this tool versus alternatives like proxmox_agent_exec or proxmox_agent_power. There is no context about prerequisites (e.g., QEMU agent must be running) or when not to use it.

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