set_machine

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

No annotations are provided, and the description does not disclose behavioral traits such as side effects, state changes, or required permissions. It merely restates the operation without explaining that changing the machine type may reset emulator state or invalidate loaded content.

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 at two sentences, with no unnecessary words. It front-loads the primary action and includes a brief note on parameter validation. Every sentence earns its place.

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's simplicity (one parameter, no output schema), the description is adequate. It covers what the tool does and how to use the parameter. However, it could mention that changing the machine type may affect the emulation state, but that is not critical for a straightforward setter.

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 schema provides full coverage with enum values and examples. The description adds value by instructing to use a 'real ZEsarUX machine identifier' and referencing 'get-machines', which guides the agent to choose a valid value. This exceeds what the schema alone offers.

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's purpose: 'Set the emulated machine type in ZEsarUX'. It uses a specific verb ('Set') and resource ('emulated machine type'), and distinguishes itself from sibling tools like 'reset_machine' by focusing on changing the machine type rather than resetting.

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 implies usage when the user wants to change the machine type, but it does not explicitly state when to use this tool versus alternatives like 'reset_machine' or 'get_emulator_info'. No exclusions or prerequisites are mentioned.

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