Skip to main content
Glama
Sign In
SolidworksMCP-python

SolidworksMCP-python

by andrewbartels1
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Get Model Info

get_model_info
Read-onlyIdempotent

Reports the active SolidWorks document's title, path, type, configuration, unsaved changes, feature count, and rebuild status, helping identify which model is active at the start of a session.

Instructions

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

Use it first in a session, to see which document is active (it follows a switch made in the SolidWorks window). For file size and dates, use get_file_properties; for every open document, use list_open_documents. Needs: an open document. Read-only. Returns: model_info with title, path, type, configuration, is_dirty, feature_count and rebuild_status (0 rebuilt, 1 needs a rebuild).

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 observedv1.0.0

TDQS

A4.7/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 still adds real context beyond them: the prerequisite of an open document and the semantics of rebuild_status (0 rebuilt, 1 needs a rebuild), which the agent cannot infer from annotations alone. It stops short of describing behavior when no document is open, keeping it at 4 rather than 5.

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?

The first sentence front-loads exactly what is reported, followed by compact usage, alternative, prerequisite and return blocks. Sentences are labeled implicitly by role ("Use it first", "Needs:", "Returns:") and nothing is wasted.

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, the description covers prerequisites, the routing decision against two siblings, and the return payload including the meaning of the one non-obvious status field. An output schema exists, so not re-explaining every field is appropriate.

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 to add and the baseline of 4 applies. The description correctly spends no space on inputs and focuses on outputs and prerequisites instead.

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 names a specific verb ("Report") and an enumerated resource list (title, path, type, configuration, unsaved changes, feature count, rebuild status) for the active document. This makes the tool clearly distinguishable from get_file_properties and list_open_documents, which cover size/dates and all open documents respectively.

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 explicitly states when to use it ("first in a session, to see which document is active"), notes the dynamic behavior that it follows a switch made in the SolidWorks window, and names two alternatives with the conditions that select them: get_file_properties for size and dates, list_open_documents for every open document.

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