revert_board

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

The description implies a destructive action (discarding unsaved changes) but does not disclose side effects such as loss of unsaved work, irreversibility, or potential impacts on selections or active state. With no annotations to fill the gap, this is insufficient.

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?

A single sentence that is front-loaded and contains no unnecessary words. Every word 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?

The description is minimal and does not address return values (though an output schema exists), execution behavior (synchronous vs async), or state changes beyond the revert. For a potentially destructive tool with no annotations, more context would be beneficial.

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 tool has zero parameters, so the description does not need to add parameter-level details. The existing text explains what invoking the tool does, which meets the baseline for no-parameter tools.

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 uses the specific verb 'revert' on the resource 'board', clearly distinguishing it from sibling tools like save_board or delete_component. The phrase 'to last saved state' further clarifies the scope of the operation.

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 revert_board versus alternatives (e.g., undo via execute_kicad_tool, or manual deletion). No prerequisites (e.g., board must have been saved) or when not to use it are mentioned.

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