Skip to main content
Glama
Sign In
SolidworksMCP-python

SolidworksMCP-python

by andrewbartels1
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Start Macro Recording

start_macro_recording

Starts SolidWorks' macro recorder to capture user actions into a macro file for later replay or editing. Currently returns not_supported until an adapter implements it.

Instructions

Start SolidWorks' macro recorder, to capture what the user does as a macro.

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": "start_macro_recording"
  }
}

Input Schema

NameRequiredDescriptionDefault
input_dataYesThe recording. `output_file` (where the macro is saved) is required; `macro_name`, `recording_mode`, the capture switches and `timeout_seconds` 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. `output_file` (where the macro is saved) is\nrequired; `macro_name`, `recording_mode`, the capture switches and\n`timeout_seconds` have defaults."
  2. First observedv1.0.0

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only say readOnlyHint=false and destructiveHint=false; the description adds the decisive behavioral fact that every call fails with error_type 'not_supported' and that this is planned for a future release. It also declares the intended side effect ('starts a recording session') and where results appear ('under data'), which is exactly the extra context annotations cannot carry.

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

Conciseness5/5

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

Purpose is front-loaded in the first sentence, followed by the availability warning, then structured 'Changes:' and 'Returns:' labels. The 'once available' qualifiers avoid misleading claims about current behavior without wasteful repetition.

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?

With an output schema present, return values do not need explaining, and the description still points to `data`. The remaining gap is workflow-level: it never says a separate stop_macro_recording call is needed to finalize the capture, which an agent would need once the tool ships.

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 every nested field (output_file, macro_name, capture switches, timeout_seconds) has its own description with defaults, so the schema does the heavy lifting. The tool description itself adds no parameter meaning beyond what the schema already states, making the baseline 3 correct.

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 first sentence names a specific verb and resource ('Start SolidWorks' macro recorder') and states the outcome ('capture what the user does as a macro'), which separates it cleanly from stop_macro_recording and the automation_* variants. It also immediately flags that the tool is unimplemented, so an agent can rule it out without opening the schema.

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

Usage Guidelines4/5

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

Strong negative guidance: 'Not available yet: no adapter implements it, so every call returns an error' tells the agent plainly not to call this, and the description redirects to the working alternative (SolidWorks Tools > Macro > Record). It stops short of distinguishing this tool from the sibling automation_start_macro_recording once both exist, so it is clear context but not full alternative routing.

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