Skip to main content
Glama
solidworks-mcp

solidworks-mcp

open_document

Idempotent

Opens a SolidWorks part, assembly, or drawing and makes it active for continued work. Use read-only mode to protect the file; already-open documents are brought to the front.

Instructions

Opens a part, assembly or drawing (.SLDPRT / .SLDASM / .SLDDRW) and makes it the active document, to continue work on it. A relative path is relative to the projects folder. If the file is already open it is just brought to the front. read_only=True opens it so that it cannot be saved over. The file itself is not modified. Starts SolidWorks if needed.

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": {
      "path": "<path>"
    },
    "name": "open_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
read_onlyNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.1

TDQS

A4.6/5.0
Behavior4/5

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

Beyond annotations it discloses that the file is not modified on disk, that SolidWorks starts if needed, and that already-open documents are only raised, which concretely explains the declared idempotentHint. The readOnlyHint=false versus 'The file itself is not modified' is reconcilable (application state still changes), but the description never says what happens when the path does not exist.

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?

Five short sentences, front-loaded with the core action and followed by scoping, idempotency, parameter behavior, and side effects. No sentence is filler; each adds a decision-relevant fact.

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

Completeness5/5

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

The tool is low-complexity with only one required parameter, and an output schema exists so return values need not be described. Path resolution, side effects, and the read-only mode are all covered, leaving nothing an agent needs missing before invoking it.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must carry the load, and it does: 'path' is defined as relative to the projects folder, and 'read_only=True' is explained as opening so the file 'cannot be saved over' rather than merely naming the flag. Both parameters gain meaning that the bare schema does not provide.

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 uses a specific verb ('Opens') plus a resource ('a part, assembly or drawing') with explicit file extensions (.SLDPRT/.SLDASM/.SLDDRW) and states the resulting state ('makes it the active document'). An agent can distinguish this from close_document or activate_document without inspecting 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?

It provides a clear usage condition ('to continue work on it') and disambiguates the already-open case ('If the file is already open it is just brought to the front'), which implicitly directs the agent away from a separate activation call. It lacks an explicit exclusion such as when to prefer activate_document or that missing files raise errors.

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