Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Search SolidWorks API

search_solidworks_api_help
Read-onlyIdempotent

Find SolidWorks API interface and member names by keyword when you don't know the exact name, then use the returned matches to look up method parameters and return types.

Instructions

Search SolidWorks API interface and member names by keyword.

Use this when you don't know the exact name: "chamfer" finds IFeatureManager.InsertFeatureChamfer. Then call lookup_api_method on a match for its parameters and return type. Matches come from the SolidWorks type library installed on this machine.

Setup: none. SolidWorks must be installed, not running; it is never contacted. Read-only. The first call builds the index (about a second) and later calls reuse it. index_status is ready (saved index), rebuilt (built for this call) or unavailable (no index could be built; guidance says why).

Returns matches (interface, member, member_type, score), guidance, and fallback_help suggesting MCP tools for the task, with year and type_library_version of the library that answered.

Example input: {"query": "chamfer", "max_results": 5}

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

Input Schema

NameRequiredDescriptionDefault
input_dataNoThe search. `query` (one or more words) is required; `max_results` and `year` have defaults.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations it discloses that SolidWorks must be installed but not running, that it is never contacted, that the first call builds an index (~1s) and later calls reuse it, and it enumerates the three index_status values with their meanings including failure guidance. It also names the bracketing metadata (year, type_library_version) returned with answers.

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-loads the one-line purpose, then usage, setup, return shape, and an example in a scannable order with no filler sentences. Minor redundancy in restating the year default and index_status semantics that the schema already covers keeps it from a 5.

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 search tool with a rich wrapper schema and an output schema, the description covers when to call it, prerequisites, cold-start behavior, failure signaling, and what to do next. Nothing needed to invoke it correctly or interpret a failure 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?

Schema coverage is 100%, so baseline is 3; the description adds value with a worked example input ('{"query": "chamfer", "max_results": 5}') and reinforces that year is normally left unset in favor of the server default. It stops short of documenting max_results range or index_file usage beyond what the schema already says.

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?

States a specific verb and resource ('search SolidWorks API interface and member names by keyword') and distinguishes itself from the sibling lookup_api_method by framing itself as the fuzzy-name entry point. An agent can tell exactly what this returns without opening 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit selection rule: 'Use this when you don't know the exact name', with a concrete example ('chamfer' finds IFeatureManager.InsertFeatureChamfer) and a handoff instruction to call lookup_api_method on a match. The complementary case (known name) is implied by that contrast, so routing is unambiguous.

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