Skip to main content
Glama
SolidWorks MCP Python

SolidWorks MCP Python

by locense

Look Up API Interface

lookup_api_interface
Read-onlyIdempotent

List all methods and properties of a SolidWorks COM interface, like IFeatureManager, to see what it offers or confirm which interface a member belongs to before calling it.

Instructions

List every method and property of a SolidWorks COM interface.

Use this to see what an interface offers, such as IFeatureManager, or to check which interface a member is really on before calling it. For one member's parameters, use lookup_api_method. Names match regardless of case.

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 with methods, properties and their counts. result.found false means the interface isn't in the type library, or no index could be built, in which case result.note says why.

Example input: {"interface": "IFeatureManager"}

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

Input Schema

NameRequiredDescriptionDefault
input_dataNoThe interface. `interface` (e.g. "IFeatureManager") is required; `year` has a default.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnly/idempotent/destructive annotations, it discloses that SolidWorks is never contacted, that the first call pays a ~1 second index build cost while later calls reuse it, the meaning of the three index_status values, and the found=false / result.note failure semantics. That is real behavioral context the annotations do not carry.

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?

Purpose is front-loaded in the first line, followed by usage, setup, caching and return semantics in short, scannable chunks. The prose is somewhat long for a one-parameter tool, but nearly every sentence carries information an agent would otherwise lack.

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 single-parameter lookup with an output schema, the definition covers purpose, alternative, prerequisites, latency, cache behavior, and how to interpret both successful and failure results. Nothing an agent needs to invoke it correctly is missing.

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 description coverage is 100%, so the schema already documents interface, year and index_file, including the case-insensitivity rule. The description only repeats case-insensitivity and adds an example input, which is marginally useful but adds little meaning beyond the structured data.

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 opening sentence gives a specific verb and resource ('List every method and property of a SolidWorks COM interface'), and the description explicitly contrasts itself with lookup_api_method ('For one member's parameters, use lookup_api_method'), so the agent can distinguish the two without opening either 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?

It names two concrete use cases ('see what an interface offers', 'check which interface a member is really on before calling it') and routes the member-parameter case to lookup_api_method. It also states prerequisites (SolidWorks installed, not running) and that no setup is required.

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