proxmox_agent_info

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

No annotations are provided, so the description shoulders the burden of behavioral disclosure. It states 'query' implying read-only, but the term 'requires elevated permissions' hints at privileged access. However, it does not explicitly confirm no side effects, nor does it describe the output or any potential latency. The listing of operations adds some transparency, but overall it's adequate but not thorough.

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?

Extremely concise: two sentences, with the primary verb and resource ('Query guest info') front-loaded, followed by a quick enumeration of operations and a permission note. No unnecessary words; every part serves a purpose.

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?

With no output schema, the description could be more complete by hinting at what each operation returns (e.g., JSON data). For a query tool, knowing the output format helps in usage. The description covers operation choices and permissions, but lacks return value context, leaving the agent to infer. This is adequate but not fully complete given the tool's verb ('query').

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 covers 2 of 3 parameters with descriptions (node, vmid) and provides an enum for operation. The description adds value by explicitly listing the operation values (ping, osinfo, etc.) and noting 'requires elevated permissions', which gives context not in the schema. This enhances understanding of the operation parameter beyond the enum alone.

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?

Description clearly states 'Query guest info via QEMU agent' with a specific list of operations (ping, osinfo, etc.). This distinguishes it from sibling tools like proxmox_agent_exec (execute commands) and proxmox_agent_file (file operations), making the purpose immediately clear.

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 notes 'requires elevated permissions', which is a usage constraint, but it does not specify when to prefer this tool over alternatives (e.g., proxmox_guest_status for basic status) or when not to use it. No explicit when-not or alternative guidance is provided.

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