pve_cloudinit_get

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

The description mentions that secret fields are masked for safety, which is a useful behavioral detail. Since no annotations are provided, the description bears the burden. It could additionally note permission requirements or error behavior, but the masking disclosure adds value beyond a simple 'read' statement.

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 two sentences, front-loaded with the primary purpose, and no superfluous wording. Every sentence contributes meaning, making it highly concise and well-structured.

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 existence of an output schema (which documents return values), the description is fairly complete. It covers the operation type, key fields returned, and references the mutation sibling with rollback context. A minor gap is not explicitly stating that the 'kind' parameter defaults to 'qemu', but it is implied by 'QEMU guest'.

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?

The input schema has 100% description coverage for all 4 parameters, so the baseline is 3. The description adds meaning by listing returned fields (ciuser, sshkeys, etc.), but this does not directly enhance parameter understanding beyond what the schema already provides.

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 'Read a QEMU guest's cloud-init configuration (read-only)', specifying the verb ('Read'), the resource ('QEMU guest's cloud-init configuration'), and its read-only nature. This effectively distinguishes it from the sibling tool 'pve_cloudinit_set' which is for mutation.

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 clear direction: 'Use pve_cloudinit_set to mutate it'. This helps the agent choose between get and set operations. However, it does not explicitly state when not to use this tool, such as when mutation is needed instead.

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