Skip to main content
Glama
FullyDefined – AI for SOLIDWORKS

FullyDefined – AI for SOLIDWORKS

list_component_faces

Lists a component's faces with IDs, types, areas, points, and normals or axes in assembly coordinates so you can select faces for mates or measurements when point picking is ambiguous.

Instructions

List the faces of one component of the active assembly: id, type (plane / cylinder / other), area, a point on the face, and the normal or the axis and radius, all in ASSEMBLY coordinates. The id is the face_id that add_mate and measure_distance take, for when picking a face by point is ambiguous. Works on a part inside a sub-assembly (component path). Read-only.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "component": "<component>"
    },
    "name": "list_component_faces"
  }
}

Input Schema

NameRequiredDescriptionDefault
unitNomm, cm, m, inch or ft
includeNoAlso list the edges and / or vertices, with ids for edge_id / vertex_id
componentYesComponent name from list_components, or a path into a sub-assembly
face_typeNoList only faces of this type

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?

No annotations are supplied, so the description carries the full burden and does so well: it declares 'Read-only', specifies that all geometry is in ASSEMBLY coordinates, and explains the id contract with other tools. It stops short of covering failure behavior (invalid component name, component with no faces), which leaves a small gap for a mutation-free read tool.

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?

Four dense sentences with the return payload front-loaded, then the id contract, then sub-assembly support. Nothing is filler, though the trailing 'Read-only.' could have been folded into the opening sentence.

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?

With no output schema and no annotations, the description does the necessary work: it documents return fields, coordinate frame, id reuse, and read-only nature. Only error/edge-case behavior and the effect of the unit parameter are left unstated.

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 each parameter is already documented; the description only reinforces the component-path case and the id output. It never mentions the unit parameter, which governs the scale of area and coordinates, nor the include/face_type options beyond echoing the type values.

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 specific verb and resource (list the faces of one component of the active assembly) and enumerates exactly what comes back: id, type, area, a point on the face, and the normal or axis+radius. It also implicitly separates itself from a pick-by-point workflow and names the consumers of the returned id (add_mate, measure_distance), so an agent can place it without opening the schema.

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?

Gives an explicit when-to-use condition: use it when picking a face by point is ambiguous, and mentions sub-assembly parts are supported via component path. It does not name the concrete alternative tool or state exclusions, so routing is guided rather than fully prescribed.

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