Skip to main content
Glama

sw_list_entities

Read-only

Identify specific faces and edges by listing their geometry and pick points. Use these extracted elements to enable AI agents to perform detailed feature selection and parametric modeling within SolidWorks.

Instructions

Faces (plane/cylinder/...) and edges (line/circle) with geometry and a pick_point for other tools.

Input Schema

NameRequiredDescriptionDefault
docNoDocument title or path. Defaults to the active document.
kindNoall
nearNoSort by distance to this model point.
limitNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior3/5

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

readOnlyHint=true and destructiveHint=false already declare the safety profile, so the description needn't restate that. It adds value by disclosing what the result contains (geometry data plus a pick_point usable by other tools), which is non-obvious and not in the schema. It does not mention default limit behavior, sorting, or truncation, which matter for a listing tool that caps at 60 by default.

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

Conciseness3/5

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

One short sentence with no filler, but it is grammatically a fragment missing its subject and verb, and the most important fact (that it lists entities for the currently open document) is left implicit. Brevity here comes at the cost of clarity rather than from efficiency.

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

Completeness2/5

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

For a listing tool with a default limit of 60, an optional document target, and a sort-by-distance option — and with no output schema — the description covers only what kinds of entities exist and that they carry geometry and a pick_point. An agent still cannot tell the default document scope, what happens past the limit, or how 'near' affects ordering.

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 50%: doc and near are documented, while kind and limit have enums/constraints but no descriptions. The description uses the word "Faces" and "edges", indirectly glossing the kind enum, but says nothing about doc scope, the near sorting parameter, or the limit cap. Baseline 3 is appropriate given partial schema coverage and no compensating detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the resource (faces, edges) with enumeration examples and hints at the returned content (geometry, pick_point), but uses no verb — it reads as a noun-phrase caption, not a statement that this lists entities in a document. It is distinguishable from sw_list_bodies and sw_list_features by the face/edge focus, though only weakly.

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?

"for other tools" implies a downstream-use scenario (get a pick_point to feed another call), which is a real usage hint. But there is no explicit when-to-use vs. alternatives, no mention of sw_list_bodies/sw_list_features, and no guidance on when to choose faces vs. edges vs. all.

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