pve_get_vm_config

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

The description focuses solely on the content returned and gives no behavioral context. It does not disclose that the operation is read-only, what happens if the VM does not exist, or how the response is structured. Since no annotations are provided, the description carries the full burden and falls short.

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, well-structured sentence that front-loads the core purpose ('Full VM config') followed by a concise list of fields. Every word adds value, and there is no redundancy or filler.

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 lists the configuration fields, giving a useful overview of the response content. However, it omits details about output format, error behavior, and permissions, which are critical given the absence of an output schema and annotations. A slightly more detailed description would make it fully self-sufficient.

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 sole parameter vm_name has no schema description, and the tool description does not mention it either. The agent must rely solely on the parameter name, with no guidance on format, required syntax, or possible values. The description fails to compensate for the missing schema coverage.

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 explicitly lists the configuration fields returned (CPU type, BIOS, boot order, NIC list, disk config, tags, description), making it clear this tool retrieves the full VM configuration. This distinguishes it from sibling tools like pve_get_vm_disks and pve_get_vm_status.

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 phrase 'Full VM config' provides clear context for when to use this tool—when the complete VM configuration is needed. However, it does not explicitly state when not to use it or mention alternative tools for more specific queries.

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