proxmox_cloudinit

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

Without annotations, the description must fully disclose behavioral traits. It only mentions 'requires elevated' for the regenerate action but omits details about idempotency, side effects, or return values for other actions. This leaves significant gaps for an agent to invoke the tool correctly.

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 extremely concise—one opening sentence plus a pipe-separated list of actions. Every sentence earns its place, and the structure is front-loaded with a high-level purpose, making it easy for an agent to parse quickly.

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 tool with 4 parameters and no output schema, the description adequately covers each action's behavior and required parameters. Minor gaps exist (e.g., what 'elevated' means, return format), but the core functionality is clearly communicated.

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?

Although schema coverage is 100%, the description adds value by mapping each action enum to a meaningful summary (e.g., 'dump: dump rendered config'), clarifying the schema's generic description for the action parameter. It also lists dump_type options explicitly, aiding understanding beyond the schema.

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 starts with 'Manage cloud-init for a QEMU VM,' clearly identifying the resource and actions. It then lists three specific actions (get, dump, regenerate) with brief descriptions, making the purpose unambiguous and distinct from sibling tools.

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 explicit usage for each action variant (e.g., 'action=get: list config'), which helps the agent select the correct action. However, it does not compare this tool to alternatives (e.g., proxmox_guest_config) or specify 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.