Skip to main content
Glama
Sign In
SolidworksMCP-python

SolidworksMCP-python

by andrewbartels1
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Stop Macro Recording

stop_macro_recording
Destructive

Stops SolidWorks macro recording and saves the recorded macro; currently planned, so calls return a not_supported error until an adapter implements it.

Instructions

Stop the macro recorder and save the recorded 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 > Stop). Changes: once available, ends the session and writes the macro file. Returns: once available, the saved macro's 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": "stop_macro_recording"
  }
}

Input Schema

NameRequiredDescriptionDefault
input_dataYesA mapping; nothing in it is used yet.

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: +"A mapping; nothing in it is used yet."
  2. First observedv1.0.0

TDQS

A4.1/5.0
Behavior5/5

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

The most important behavioral fact for an agent, that the tool is a non-functional stub that always errors with a specific error_type, is disclosed prominently and cannot be derived from the annotations. It also discloses the post-implementation side effects (ends the session, writes the macro file) and where results appear (data), complementing the destructiveHint=true annotation.

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 structure is sensible: capability statement first, availability caveat second, then behavior and return value. The repeated "once available" hedging across three separate lines is slightly redundant but each line carries distinct information.

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 stub tool it covers what an agent needs: it does not work, what error to expect, what to do instead, and what it will do later. The output schema already documents return shape, so the brief mention under data is sufficient. Only the relationship to the similarly named sibling stop tools is unaddressed.

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 single input_data parameter is self-documenting ("A mapping; nothing in it is used yet"). The description adds no parameter detail, but none is needed, so the baseline of 3 applies.

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

Purpose4/5

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

"Stop the macro recorder and save the recorded macro" gives a specific verb (stop) and resource (macro recording) with the side effect (saving the file) stated up front. It is clear what the tool would do, though it does not distinguish itself from similarly named siblings such as automation_stop_macro_recording.

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?

It explicitly says when NOT to call it: "no adapter implements it, so every call returns an error with error_type: not_supported," and names the working alternative path (SolidWorks Tools > Macro > Stop). That is actionable guidance. It stops short of describing the intended call context once implemented or routing between the sibling stop tools.

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