vm_file_read

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

The description mentions the QEMU Guest Agent, implying a dependency, but does not disclose behavioral traits such as error handling (e.g., file not found, agent unavailable), file size limits, or whether binary files are supported. With no annotations, the description should provide more detail.

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 conveys the core purpose without extraneous words. It is efficiently front-loaded but could benefit from slightly more context without becoming verbose.

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 tool with three required parameters, no output schema, and no annotations, the description lacks completeness. It omits return value (file content), potential errors, and prerequisites (QEMU Guest Agent running), leaving gaps for an AI agent.

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 three parameters (node, path, vmid). The description adds no additional parameter semantics beyond the schema, so a baseline score of 3 is appropriate.

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 reads a file in a VM via the QEMU Guest Agent. It specifies the verb 'Lit' (reads), the resource 'un fichier dans une VM', and the mechanism 'via le QEMU Guest Agent', which distinguishes it from SSH-based file reads.

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?

No guidance is provided on when to use this tool versus alternatives like ssh_read_file or vm_file_write. There is no mention of prerequisites (e.g., QEMU Guest Agent must be installed) or exclusions, leaving the agent to infer usage context.

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