Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

set_component_visibility

Hide or show assembly components, including parts inside sub-assemblies by path, to declutter the view without suppressing mates, interference checks, or mating.

Instructions

Hide or show components of the active assembly (visible = false hides). Hiding only stops the drawing: the component's mates still hold, it still counts in check_interference and it can still be mated to. A part inside a sub-assembly is addressed by path ('Door-1/Slat-3'), and a list changes several components in one call. list_components marks hidden ones with 'hidden': true.

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

Input Schema

NameRequiredDescriptionDefault
visibleNofalse = hide, true = show
componentNoOne component, instead of the list
componentsNoComponent names or paths

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does substantial work: it discloses that hiding is non-destructive (mates still hold, the component still counts in check_interference, and it can still be mated to). That is exactly the kind of non-obvious side-effect an agent needs. It stops short of saying whether the change persists to disk or how it affects drawings/BOMs.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the action and polarity before the caveats. Every clause carries distinct information — no restating of the name and no filler.

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 three-parameter mutation tool with no output schema, the description covers addressing, batching, and the crucial semantic that hiding is not removal. The only gap is what the call returns or whether a rebuild/save is required, which is minor.

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?

Schema coverage is 100%, so the default baseline is 3, but the description adds real value beyond the schema by documenting the path syntax for nested components and the relationship between the single 'component' and list 'components' forms. Only the default-to-hide behavior repeats what the schema already states.

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?

States a concrete verb pair ("Hide or show") and a scoped resource ("components of the active assembly"), and immediately disambiguates the parameter polarity with "visible = false hides". An agent can distinguish this from delete_component or set_component_fixed from the description alone.

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 operational context: use the path form 'Door-1/Slat-3' for parts inside sub-assemblies, and use the list form to change several components in one call. It also points to list_components for verifying hidden state. It does not explicitly contrast with permanent-removal siblings such as delete_component, so there is no stated when-not-to-use.

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