Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Find Related API Members

find_related_api_members
Read-onlyIdempotent

Find SolidWorks API members related to an interface or member name, including shared-interface members and name matches, to explore the API around a known call.

Instructions

Find SolidWorks API members related to an interface or member name.

For an interface: its own members. For a member: the other members of every interface that also has it (often used together), plus members whose names contain it. Use it to explore around a call you know, such as what sits beside InsertSketch.

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).

Returns result.related: each member's interface, name, type and why it is related. result.found false means nothing matched, or no index could be built, in which case result.note says why.

Example input: {"name": "InsertSketch", "max_results": 10}

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

Input Schema

NameRequiredDescriptionDefault
input_dataNoWhat to explore. `name` (an interface or member) 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.1/5.0
Behavior5/5

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

Beyond the annotations, it discloses that SolidWorks is never contacted, setup is none, the first call builds an index in about a second and later calls reuse it, and index_status can be ready, rebuilt, or unavailable. It also explains result.found false and result.note, which is unusually complete behavioral context.

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?

The description is front-loaded with purpose and organized into short functional paragraphs. It is somewhat long, but nearly every sentence adds useful behavioral or return-value context rather than repeating the 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 tool with an output schema, it still explains the key return shape (result.related and result.found) and the index status values. Combined with setup requirements, usage example, and failure semantics, nothing important is missing for correct invocation.

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

Parameters3/5

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

Schema coverage is 100%, so the schema already documents name, year, index_file, and max_results thoroughly. The description adds an example input and reinforces the interface-vs-member meaning of name, but it does not add much beyond what the schema already provides for the other parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: find SolidWorks API members related to an interface or member name. It clearly explains the two modes (interface vs. member) and gives a concrete example, but does not explicitly differentiate itself from sibling lookup or search tools.

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 gives clear usage context, saying to use it to explore around a call you already know, such as what sits beside InsertSketch. It does not explicitly name alternatives or when not to use it, so it falls short of full when/when-not guidance.

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