Skip to main content
Glama
Sign In
SolidworksMCP-python

SolidworksMCP-python

by andrewbartels1
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Start Macro Recording (Automation)

automation_start_macro_recording

Starts a SolidWorks macro recording session to capture mouse and keyboard actions for CAD automation; planned feature, currently returns not_supported.

Instructions

Start SolidWorks' macro recorder (the automation family's copy of start_macro_recording).

Not available yet: no adapter implements it, so every call returns an error with error_type: "not_supported". It is planned for a future release. Recording is done in SolidWorks today (Tools > Macro > Record). Changes: once available, starts a recording session. Returns: once available, the session details under data.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "input_data": "<input_data>"
    },
    "name": "automation_start_macro_recording"
  }
}

Input Schema

NameRequiredDescriptionDefault
input_dataYesThe recording. Nothing is required: `macro_name`, `output_file`, `recording_mode` and the capture switches have defaults.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • changedInput schema / properties / input_data / description
      Previous value: -"The input data value."New value: +"The recording. Nothing is required: `macro_name`,\n`output_file`, `recording_mode` and the capture switches have\ndefaults."
  2. First observedv1.0.0

TDQS

A4.3/5.0
Behavior4/5

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

The annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false) only sketch a non-destructive mutation, but the description adds the decisive behavioral fact that the tool is unimplemented and always errors, plus that it will start a session and return session details under `data` once available. This is real value beyond the structured fields, though it does not say whether such errors are retryable or how the failure surfaces at the protocol level.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The unavailability warning is front-loaded in the first two sentences, which is exactly right, and the rest is short. The trailing 'Changes: once available...' / 'Returns: once available...' pair is slightly boilerplate given an output schema exists, but it costs little.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter tool with a full schema, full coverage, and an output schema, the definition supplies everything an agent needs to decide correctly: it is a stub that always fails, and what it will eventually do. The only gap is a lack of guidance on whether to plan around it or ignore it entirely in multi-step automation flows.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the nested input_data fields (macro_name, output_file, recording_mode, capture switches, defaults) are each documented in the schema itself. The description adds no parameter-level meaning of its own, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ('Start SolidWorks' macro recorder') and immediately distinguishes it from the sibling start_macro_recording by calling it 'the automation family's copy'. An agent can tell which of the two macro-recording entry points it is looking at without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives the strongest possible when-not-to-use signal: 'no adapter implements it, so every call returns an error with error_type: "not_supported"' and 'It is planned for a future release.' It also names the current alternative path ('Recording is done in SolidWorks today (Tools > Macro > Record)'), so the agent knows what to do instead rather than simply being blocked.

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

Deploy Server

Other Tools