Skip to main content
Glama

Inspect Model

inspect
Read-only

Use this when you need to read facts about a model. One reader, selected by of:

  • 'assembly' — physical assembly inventory (parts, bboxes, connectors, mates, disconnected solids).

  • 'robot' — URDF/SDFormat export preview (links, joints, planning groups, end-effectors, issues).

  • 'step' — inspect an imported STEP file.

  • 'shape' — volume / surfaceArea / bbox for one feature ({ feature_id? }).

  • 'features' — features captured by the script (kind, id, params, transforms, suppression).

  • 'assemblies' — assembly intent (assemblies, parts, connectors, joints).

  • 'topology' — canonical face names + edge count for a feature ({ feature_id? }).

  • 'edges' — edges of a shape with optional EdgeQuery ({ feature_id?, query? }); returns @kc[...] refs.

  • 'face-edges' — boundary edges of a named canonical face ({ feature_id?, face_name }).

  • 'faces' — faces of a shape with optional FaceQuery ({ feature_id?, query? }); returns @kc[...] refs.

  • 'face-labels' — user-applied labels visible in the script.

  • 'mates' — mates captured by the script.

  • 'constraints' — sketch constraints captured by the script.

  • 'part-stats' — bundled parts-catalog statistics.

  • 'bend-table' — sheet-metal bend table for a flattened pattern.

  • 'params' — declared model parameters.

  • 'part-categories' — top-level part-catalog categories available in the bundled (and configured remote) catalog.

  • 'part-families' — part families within a category ({ category? }); count + exemplar ids per family. All params except of are subject-specific and forwarded verbatim. Most subjects accept { file | code }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ofYesWhich facts to read.
codeNoInline kernelCAD script source.
fileNoPath to a .kcad.ts script file.
queryNoof:'edges'|'faces' — optional EdgeQuery/FaceQuery filter.
assemblyNoof:'assembly'|'robot' — assembly name; defaults to the first captured assembly.
categoryNoof:'part-families' — optional top-level category to filter families by.
face_nameNoof:'face-edges' — canonical face name (required for that subject).
feature_idNoof:'shape'|'topology'|'edges'|'faces'|'face-edges'|'face-labels' — FeatureId; defaults to the last returned shape.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okNoWhether the read succeeded.
errorNoFailure message (present on failure).
errorCodeNo

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false. Description adds that parameters are subject-specific and forwarded verbatim, providing useful behavioral context beyond annotations.

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?

Bulleted list of subjects after a concise purpose statement. Each sentence earns its place; no wasted words despite length.

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?

Given the tool's complexity (8 params, many subjects, output schema exists), the description covers all necessary information: subjects, parameter semantics, and usage context. No gaps.

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%, baseline 3. Description explains `of` enum values in detail and adds that other params are subject-specific, but does not add significant new meaning beyond the schema.

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?

Starts with 'Use this when you need to read facts about a model,' clearly stating verb+resource. The broad list of subjects distinguishes it from sibling tools that add/modify/query.

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?

Explicitly states when to use (reading facts) and briefly explains parameter behavior ('All params except `of` are subject-specific'). Does not name alternatives but context is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation4/5

Tools are mostly distinct, with clear descriptions for each. However, there is some potential overlap between inspection tools like 'inspect' and 'mesh_summary', and between rendering tools 'render_preview' and 'get_latest_render', which could cause minor confusion.

Naming Consistency5/5

All tool names follow a consistent snake_case verb_noun pattern, making it predictable for an agent to infer functionality.

Tool Count2/5

44 tools is significantly higher than the typical well-scoped range of 3-15. While the domain is complex, the count feels excessive and could overwhelm an agent.

Completeness4/5

The tool set covers an extensive range of CAD operations including creation, inspection, rendering, export, and verification. Minor gaps exist, such as direct sketch editing tools, but overall it is comprehensive.