Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

list_open_documents

Lists all open SOLIDWORKS documents with title, type, file path, and unsaved-change status so you can identify which models need saving.

Instructions

List every document that is open in SolidWorks: title, type, path (empty when never saved) and unsaved_changes (true when it was never saved or has changed since its last save; the result names those).

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does real work: it enumerates the returned fields and defines the two non-obvious semantics — path is empty when never saved, and unsaved_changes is true when never saved or modified since last save. It does not state ordering, behavior on an empty document set, or error conditions, which keeps it from a 5.

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 front-loaded sentence with no wasted framing: purpose first, then the return contract. The parenthetical definitions are dense but each earns its place; a bulleted or semicolon-separated field list would scan slightly better.

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 tool with no output schema, the description supplies enough: what is returned, the shape of the key fields, and the edge cases that would otherwise cause misinterpretation. Only result ordering and empty-state behavior are absent, which are minor for this tool.

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 the baseline applies and there is nothing for the description to clarify beyond what the empty schema already shows.

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 opens with a specific verb and resource ('List every document that is open in SolidWorks') and immediately names the fields returned, so an agent can distinguish it from open_document, list_components, or list_features without inspecting any schema.

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 it should call this to discover what is currently loaded before acting on a document. There is no explicit when-to-use statement, no exclusion of alternatives such as open_document, and no note about what to do if nothing is open.

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