Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Get Model Info

get_model_info
Read-onlyIdempotent

Retrieve read-only details about the active SolidWorks document, including title, path, type, configuration, unsaved changes, feature count, rebuild status, and file metadata, to identify it at session start.

Instructions

Report the active document's title, path, type, configuration, unsaved changes, feature count, rebuild status and file details.

Use it first in a session, to see which document is active (it follows a switch made in the SolidWorks window). For every open document, use list_open_documents; for custom properties, get_custom_properties. Needs: an open document. Read-only. Returns: model_info with title, path, type, configuration, is_dirty, feature_count, rebuild_status (0 rebuilt, 1 needs a rebuild), and the file's size_bytes, created and modified (Unix timestamps; null for a document never saved).

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

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 description only restates 'Read-only' with no added value there. It does add genuinely non-obvious behavior: the result tracks the document active in the SolidWorks window, including a switch made in the app itself, and it flags the open-document prerequisite. The rebuild_status encoding (0 rebuilt, 1 needs rebuild) and null-on-never-saved semantics are useful but overlap with return-value territory an output schema already covers.

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?

Front-loaded with purpose, then usage routing, then prerequisites, then returns — a sensible ordering. The only waste is repetition: the opening sentence already enumerates title, path, type, configuration, dirty state, feature count, rebuild status and file details, and the 'Returns:' clause enumerates the same fields again.

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-argument read tool with annotations and an output schema, the definition covers everything an agent needs: what it returns at a high level, that it requires an open document, and how it relates to the neighboring list/metadata tools. The enumerated return fields are technically redundant with the output schema, but they do not mislead or omit anything.

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 no parameters, so there is no argument semantics to explain; baseline for a zero-param tool is 4. The description correctly spends no words on inputs and instead directs attention to scope and prerequisites.

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?

Names a specific verb ('Report') and a precise scope: the ACTIVE document's title, path, type, configuration, dirty state, feature count, rebuild status and file details. It also draws the boundary against siblings explicitly ('For every open document, use list_open_documents; for custom properties, get_custom_properties'), so an agent can pick it without opening a 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 an explicit when-to-use ('Use it first in a session, to see which document is active'), names two alternatives with the conditions that select them, and states the prerequisite ('Needs: an open document'). Nothing about selection is left to inference.

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