qemu_keyboard_key

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

Beyond the annotations, the description discloses that the VM remains locked by this session and instructs calling vm_unlock when finished. This is a critical behavioral side-effect not captured in the structured metadata. It also implies the command works outside the guest agent's ready state.

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 only two sentences, both front-loaded with the core action and critical caveat. Every word earns its place, with no unnecessary elaboration.

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 covers the core functionality and the essential locking behavior, but lacks parameter details and edge cases (e.g., key format, action semantics). Given the tool's simplicity and absence of an output schema, it is adequate but not fully complete.

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 description provides no information about parameters. There is no explanation of what constitutes a valid 'key' in QMP qcode format, the meaning of the 'action' enum values (down, up, press), or how vm_id is used. With 0% schema description coverage, the description fails to compensate completely.

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 sends a QMP qcode key event, with a specific timing context (before or after guest-agent startup). This distinguishes it from sibling keyboard tools that likely use the guest agent, though it doesn't explicitly name alternatives.

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 'before or after guest-agent startup' indicates when this tool is appropriate, such as when the guest agent is not yet running. It doesn't provide explicit when-not guidance or mention alternative tools, but the timing context is a clear usage signal.

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