Skip to main content
Glama
solidworks-mcp

solidworks-mcp

list_open_documents

Read-onlyIdempotent

Lists all documents open in SolidWorks with title, path, type, unsaved-change status, window availability, and active document.

Instructions

Documents open in SolidWorks: title, path, type, whether they have unsaved changes, whether they have a window (parts loaded only by an assembly have none) and which one is active.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
countYes
activeYes
documentsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds genuine context beyond them: unsaved-change state, window presence, and the note that parts loaded only by an assembly have no window, plus which document is active — these shape how results should be interpreted.

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?

One sentence with no filler, and the enumerated attributes are the useful part. It reads as a fragment without an explicit verb, which is slightly awkward but not wasteful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter, read-only listing tool with full annotations and an existing output schema, this is essentially complete. The field enumeration partly duplicates the output schema, but the window/active-document caveat is valuable semantic context that the schema alone may not convey.

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 nothing for the description to disambiguate and the baseline of 4 applies. The description correctly mentions no arguments, consistent with the empty schema.

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 names a specific resource (open documents in SolidWorks) and enumerates the attributes returned, which lets an agent distinguish it from siblings such as list_configurations or close_document. It is phrased as a noun fragment rather than an explicit verb+resource statement, so it is clear but not maximally crisp.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

Usage is only implied: an agent can infer this is the tool to call to inspect the current session's open documents. There is no explicit when-to-use framing and no routing to related siblings like activate_document or close_document, which typically follow from knowing what is open.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.