pve_get_vm_agent

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

Without annotations, the description carries the burden of behavioral transparency. It discloses a dependency (guest agent must be installed) and the data returned, but does not describe what happens if the agent is absent, whether the operation is read-only, or any error behavior. This is minimally adequate but lacks depth.

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, information-dense sentence: it names the tool's resource, lists the specific data fields, and states the agent requirement. Every element is essential, and there is no wasted wording.

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 read-only tool with one parameter and no output schema, the description covers the core purpose, returned data, and a critical dependency. It does not detail parameter usage or failure modes, but given the tool's simplicity and the obvious vm_name parameter, this is sufficient for contextual completeness.

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 0% for the single vm_name parameter, and the description does not explicitly explain the parameter. While the parameter is inferable from the tool name and description, the description adds no semantic value beyond the schema, failing to compensate for the lack of schema documentation.

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 the tool's purpose: retrieving QEMU guest agent data including IP addresses, OS info, and hostname. This specific resource and data list distinguish it from sibling tools like pve_get_vm_status or pve_get_vm_config, which focus on other aspects of VM information.

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 a key usage condition: 'Requires agent installed inside VM,' which tells the user when this tool is applicable. It does not explicitly mention alternatives or exclusions, but the prerequisite effectively guides usage for a get-type tool.

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