Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

List Open Documents

list_open_documents
Read-onlyIdempotent

Lists every document open in SolidWorks and identifies the active one, so you can target the right file or diagnose tool calls acting on the wrong document.

Instructions

List every document open in SolidWorks and say which one is active.

Use it before activate_document, or when tool calls seem to act on the wrong document. Needs: SolidWorks running. Read-only. Returns: documents (each with title, path, type and is_active) and count.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_open_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds a real prerequisite — SolidWorks must be running — which no annotation conveys, though the 'Read-only' line simply repeats the annotation rather than adding to it.

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?

It is short and front-loaded, with a clear Needs/Behavior/Returns layout that scans well. The small cost is the 'Read-only' sentence and the field-by-field return list, which partially duplicate the annotations and the output schema.

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?

For a zero-parameter read tool with an output schema, the description covers the gaps that schema and annotations cannot: the SolidWorks-running prerequisite, the diagnostic use case, and the ordering relative to activate_document. Nothing needed to call it correctly is missing.

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

Parameters4/5

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

The tool takes zero parameters, so there is no parameter meaning for the description to supply; the baseline for a no-param tool applies. Nothing in the description misrepresents or muddies the empty input schema.

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 opens with a specific verb and resource: 'List every document open in SolidWorks and say which one is active.' It is distinguishable from siblings such as activate_document and list_components, and it names the domain object (documents) plus the scope (open).

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?

It gives two concrete triggers: call before `activate_document`, and call when tool calls appear to target the wrong document. The alternative it routes to is named explicitly, so the agent doesn't have to infer ordering or diagnosis usage.

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