proxmox_guest_shutdown

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

No annotations are provided, so the description must stand alone. It only states 'gracefully shutdown' and 'requires elevated permissions,' but does not disclose behavior like timeout, success/failure indication, or whether it is synchronous. This is insufficient for an agent to fully understand the tool's behavior.

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 a single concise sentence that covers the action, resource types, and permission requirement. No unnecessary words.

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 shutdown action with three parameters and no output schema, the description covers the core functionality. However, it lacks information about return values, error conditions, and whether the shutdown is blocking. It meets minimum adequacy 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 67% (node and vmid described, type has enum values). The description repeats the enum values ('type=vm or type=lxc') but adds no new meaning beyond the schema. Baseline applies; no extra value.

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 specifies the action ('gracefully shutdown'), the target resource ('VM (type=vm) or LXC container (type=lxc)'), and a key requirement ('requires elevated permissions'). It distinguishes this tool from sibling tools like proxmox_guest_stop (likely forceful) and proxmox_guest_reboot.

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 implies when to use (for graceful shutdown) but does not explicitly state when not to use or mention alternatives. It hints at elevated permissions but lacks direct comparison to sibling tools like proxmox_guest_stop for forceful shutdown.

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