Suspend guest

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

With no annotations provided, the description must fully disclose behavioral traits. It explains the core behavior (RAM freeze vs. disk hibernate) but omits important details such as whether the operation requires specific permissions, whether it is destructive, or what happens to active network connections. These gaps limit transparency.

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 extremely concise—two sentences with no extraneous words. It front-loads the primary action and then provides a conditional alternative. Every sentence serves a clear purpose, making it efficient for an agent to parse.

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?

Given the tool has only two parameters, no output schema, and no nested objects, the description is largely complete. It covers the main use cases (pause and hibernate) and specifies the toDisk option. However, it could be improved by mentioning the expected state of the guest (running) and any asynchronous behavior or return values.

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 coverage is 100%, so the baseline is 3. The description reiterates the toDisk parameter's function but does not add new information beyond the schema's description. The guest parameter is not elaborated beyond the schema's 'VMID or name' specification. Thus, the description provides minimal added semantic value.

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 action ('Suspend (pause) a running VM') and the resource ('VM'), with specific detail about freezing in RAM for instant resume. It also distinguishes an alternative behavior (hibernate to disk via toDisk parameter). This effectively differentiates the tool from siblings like stop_guest or shutdown_guest.

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 explains when to use the tool (to pause a running VM for instant resume) and provides guidance on using toDisk as an alternative. However, it does not explicitly contrast with other virtual machine lifecycle tools like stop or shutdown, nor does it mention prerequisites (e.g., guest must be running).

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