Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

list_custom_properties

Lists the active SOLIDWORKS document's custom properties, including name, typed value, resolved linked value, and type; optionally reads a named configuration. Read-only.

Instructions

List the custom properties of the active document: name, value as typed, resolved value (a linked value such as '"SW-Mass@Bracket.SLDPRT"' shows its result) and type. The file's own properties unless configuration names one of its configurations. Read-only.

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_custom_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
configurationNoA configuration of the part or assembly (default: the file's own properties)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/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 well: it declares the tool read-only, scopes results to the file's own properties by default, and explains that linked values such as '"SW-Mass@Bracket.SLDPRT"' are returned both as typed and resolved. Missing only minor context such as behavior for an invalid configuration name.

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?

Three tight clauses, front-loaded with the resource and return fields, with no filler. The linked-value example earns its place by clarifying 'resolved value', though the sentence is dense enough that the configuration clause reads as an afterthought.

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 one-optional-parameter read tool with no output schema, the description covers what is returned (all four fields), the read-only nature, and the configuration scoping. Nothing an agent needs in order to call 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 coverage is 100% and the single optional parameter is already documented as "A configuration of the part or assembly (default: the file's own properties)". The description restates that same meaning with slightly more precision, so it adds little beyond the schema but is not misleading.

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?

Specific verb plus resource: it lists custom properties of the active document and enumerates the returned fields (name, typed value, resolved value, type). It is clearly distinguishable from set_custom_properties, though it never names that sibling explicitly.

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 implied rather than stated: "Read-only" and the note that it returns the file's own properties unless a configuration is named tells the agent when the parameter applies, but there is no explicit when-to-use/when-not guidance or reference to the setter alternative.

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