qemu_serial

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

Annotations already cover read-only, idempotent, non-destructive behavior, but the description adds real lifecycle context not present in them: the console remains readable after the VM has exited and stays visible only until qemu_list reaps it. That reaping dependency is the key behavioral fact an agent would otherwise miss; return format is left to the output schema.

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?

Three short sentences, front-loaded with the operation, then the non-obvious lifecycle behavior, then the one parameter constraint. Nothing is redundant and nothing is buried.

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?

An output schema exists, so return values need not be described, and the description covers the non-obvious lifecycle and the tail_lines constraint. The remaining gap is what `name` refers to and how to obtain it, which matters for a required parameter with no schema description.

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%, so the description must carry parameter meaning. It does add a real constraint for tail_lines ('must be positive', beyond the schema's default of 50), but the required `name` parameter is never explained or tied to the VM identifiers returned by qemu_list.

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 states a specific verb and resource: reading the tail of the VM's serial console output on COM1, with the scope ('tail') made explicit. It implicitly separates itself from qemu_serial_send (writes) and qemu_wait_serial (blocks for a pattern), but never names those siblings, so the differentiation is left partly to inference.

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?

It gives a clear use case: retrieving output after a guest crash or `quit` via qemu_qmp, when the VM is no longer live. It does not state when to prefer qemu_wait_serial or qemu_screenshot instead, nor any exclusions, so the when-to-use guidance is strong but incomplete.

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