automation_start_macro_recording

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

Since no annotations are provided, the description should disclose behavioral traits such as side effects (e.g., UI changes), permissions required, or that recording will capture subsequent user actions. The description only mentions capturing actions and generating scripts, which is minimal.

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 concise with two sentences, front-loading the main purpose. However, it could be more structured by adding key behavioral details without adding length.

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 output schema exists, return values are not needed, but the tool has a nested input object with many parameters. The description does not explain how to use these parameters or that recording must be stopped later (e.g., via 'automation_stop_macro_recording').

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 description coverage is 100%, so baseline is 3. The description does not add meaning beyond the schema; it does not mention any parameters or their purposes.

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 explicitly states the tool starts macro recording in SolidWorks to capture user actions and generate scripts. However, it does not differentiate from the sibling tool 'start_macro_recording', which likely serves the same purpose.

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 this tool versus alternatives like 'start_macro_recording' or when recording is appropriate. The description lacks context on prerequisites or usage scenarios.

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