Skip to main content
Glama

List Face Roles

list_face_roles
Read-only

Read back semantic face roles declared on a part and re-resolve each stored tag against current geometry, so drifted or deleted faces are reported instead of silently resolving wrong.

Instructions

Read back the semantic face roles declared on a part (see annotate_face).

Each entry re-resolves its stored tag against the CURRENT geometry, so a drifted or deleted face is reported rather than silently resolving wrong.

Returns a list (sorted by name) of dicts: name (str) the annotation key role (str) inlet | outlet | sealing | wetted | ambient | mating tag (str) the f_* face tag the role is bound to present (bool) whether that tag still resolves on the current shape index (str) 'FaceN' on the current shape (only when present) meta (dict) the verbatim metadata (only when set)

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": {
      "handle": "<handle>"
    },
    "name": "list_face_roles"
  }
}

Input Schema

NameRequiredDescriptionDefault
handleYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, it discloses the key non-obvious behavior: each entry re-resolves its stored tag against current geometry so drift or deletion is surfaced rather than silently mis-resolving. It also fully enumerates the return fields and the conditional presence of index/meta, which the annotations do not cover.

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?

The first sentence front-loads the action and the reference to annotate_face; the second sentence carries a genuinely load-bearing caveat about re-resolution. The return-field block is compact and necessary given there is no output schema, so every line earns its place.

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, the explicit return-shape listing makes the definition callable and interpretable without probing. The remaining gap is the unexplained handle parameter, plus no note on what happens when zero roles are declared (empty list vs. error).

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 only 50%: workspace is documented in the schema, but handle has no description anywhere in structured data. The phrase 'on a part' loosely implies handle identifies the target part, but the description adds no real semantics for handle and never mentions workspace. With half the parameters undocumented, this is a partial gap rather than a satisfied baseline.

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 ('Read back the semantic face roles declared on a part') and ties itself to the sibling that produces them ('see annotate_face'). An agent can distinguish this from list_faces/query_faces/resolve_face, which operate on raw geometry rather than declared annotations.

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?

The pairing with annotate_face gives clear context for when this tool is the right one: after roles have been declared, to read them back. It stops short of naming explicit alternatives or exclusions (e.g., 'use list_faces to enumerate all faces without roles'), so it does not reach a 5.

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