edit_macro

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

No annotations provided; description solely carries burden. It only states opens in editor without disclosing if it modifies the macro, requires SolidWorks open, or effects on other sessions. Lacks behavioral details.

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?

Single sentence, front-loaded with action. Concise but could include more context without losing efficiency.

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?

Simple tool with one parameter and no output schema; description is minimally adequate but lacks context like what happens after opening or prerequisites. Could be more complete given complexity.

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 schema documents macroPath. Description does not add additional meaning beyond that, meeting baseline.

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?

Description clearly states the tool opens a macro in the SolidWorks VBA editor, using specific verb+resource. It distinguishes from siblings like run_macro or convert_text_to_native_macro by focusing on editing.

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 on when to use vs alternatives such as run_macro or edit_sketch. The description implies usage for editing but lacks explicit when-not or context.

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