ms_gui_add_vacuum_current

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

The description explains that the tool modifies the document in place and describes the behavior of the two modes. With no annotations provided, it adds some transparency but does not cover side effects, permissions, or prerequisites.

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 two sentences with no redundant information. It front-loads the core purpose and follows with mode explanations, making it efficient and well-structured.

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 9 parameters and no output schema, the description is insufficient. It covers the main action and two modes but omits parameter details, return behavior, and prerequisites, leaving the agent underinformed.

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 only 11% (only thickness has a description). The description adds context for 'mode' and implies 'axis' by mentioning 'chosen lattice length', but does not explain other parameters like exportFile, ballAndStick, documentName, etc.

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 adds vacuum to the current GUI periodic document 'in place' and only when explicitly requested. However, it does not differentiate from the sibling 'ms_gui_cleave_surface_vacuum_current', which also deals with vacuum.

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 explicitly states the tool is used when the user asks for vacuum and explains when to use each mode (extend_lattice for 3D cells, vacuum_slab for 2D surfaces). However, it lacks guidance on when not to use this tool versus alternatives.

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