Guest Agent Info

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

Annotations declare readOnlyHint=true, which aligns with the description's 'query' nature. The description adds value by mentioning 'requires elevated permissions', which is a behavioral constraint not captured in annotations. However, it doesn't disclose what specific permissions are needed or whether there are rate limits or side effects, though the read-only hint covers most safety concerns.

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 sentence that packs essential information: the action (query guest info), the method (via QEMU agent), and the operation enum with a permission note. It is front-loaded with the core purpose and no wasted 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?

Given the tool's moderate complexity (multiple operation types) and no output schema, the description provides the operation enum and permission requirement. However, it doesn't explain what each operation returns or when to choose one over another. The lack of output schema means the description should clarify expected return formats, which it doesn't. The annotations cover safety, so the main gap is operational detail.

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 schema already documents node and vmid adequately (67% coverage). The description adds value by explaining the operation parameter with its enum values and the permission requirement. Since operation is the key parameter for selecting the query type, the description compensates for the schema's brief description by listing options and emphasizing elevated permissions.

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 queries guest info via the QEMU agent and lists the specific operations it supports (ping, osinfo, fsinfo, etc.). It distinguishes from sibling agent tools (proxmox_agent_exec, proxmox_agent_file) by focusing on info retrieval rather than execution or file operations.

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 usage for querying guest information, and the enum operation parameter provides clear options. However, it does not explicitly state when to use this tool instead of others, such as when to use proxmox_agent_hw or proxmox_guest_config. The mention of 'requires elevated permissions' gives a hint but no explicit alternatives or exclusion criteria.

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