pve_cloudinit_set

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

With no annotations provided, the description carries the full burden. It starts with 'MUTATION' to indicate state changes, explains dry-run, synchronous execution, and that secret fields like cipassword are never echoed. This is good, but it could mention prerequisites like the guest being a QEMU VM or cloud-init being enabled.

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?

Two sentences with no fluff. The first sentence immediately states the purpose and key examples. The second sentence covers dry-run, confirm, synchronous behavior, and secret handling. Front-loaded and efficient.

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?

The description covers core behavior (mutation, dry-run, confirm, secrets) and references the output schema is present but not explained. It lacks context on guest requirements (e.g., must be QEMU, must exist) and error handling, but overall it's sufficient for a well-understood operation.

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%, so the description must add meaning. It gives examples of cloud-init fields (ciuser, sshkeys, ipconfigN) and mentions secret fields, which helps understand the 'changes' parameter. However, it does not detail other parameters like vmid, node, kind, or the confirm flag beyond its basic use.

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 'set cloud-init fields on a QEMU guest' with specific examples like ciuser, sshkeys, ipconfigN. It uses the explicit verb 'set' and the resource is well-defined. The sibling pve_cloudinit_get exists for reading, so this tool is well-differentiated.

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 the dry-run default behavior and how to execute with confirm=True, providing clear context for when to use each mode. It mentions synchronous execution and secret handling, but does not explicitly list when not to use the tool or alternative tools for related tasks.

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