Begin recording SolidWorks user actions to a macro file, enabling later playback and automation of repetitive CAD workflows.
Start recording a SolidWorks macro.
This tool initiates macro recording to capture user actions for later playback and automation.
| Name | Required | Description | Default |
|---|---|---|---|
| input_data | Yes | The input data value. |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v1.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses that recording captures user actions but does not mention whether it overwrites existing recordings, requires an open document, or what happens on errors.
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?
Two efficient sentences, front-loaded with the key purpose, and no unnecessary words.
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 adequate for a simple tool but lacks context about output, session management, and prerequisites. Given the complexity (nested params, output schema), it could be more informative.
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 input schema has 100% description coverage for nested properties, so the schema provides adequate meaning. The description adds no extra semantic value beyond 'initiates macro recording'.
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 verb 'Start recording' and the resource 'SolidWorks macro', and it distinguishes from sibling tools like 'stop_macro_recording' and 'execute_macro'.
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 the tool is used to capture user actions for playback, but it does not explicitly state when to use it versus other tools nor provide any exclusions or alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.