Skip to main content
Glama
hram

FreeCAD MCP

by hram

inspect_part

Inspect valid world-space geometry, planar faces, and cylindrical hole candidates before assembly work, with paginated results and feature totals to guide interface definition.

Instructions

Inspect world-space valid geometry, planar faces and cylindrical hole candidates.

Start here before assembly work. Face names are temporary references; define_interface
binds them to geometry fingerprints. Does not move parts or change the camera.
Faces are paginated (1..500 per type); follow next_plane_offset/next_cylinder_offset
when present. feature_counts gives full totals.

Input Schema

NameRequiredDescriptionDefault
partYes
doc_nameYes
plane_offsetNo
feature_limitNo
cylinder_offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does disclose the key behavioral traits: it is read-only in effect ("Does not move parts or change the camera"), faces are paginated at 1..500 per type, and face names are temporary references rather than stable IDs. It omits any mention of permissions, error conditions, or what the response actually contains.

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?

Five short sentences, front-loaded with the purpose before the sequencing advice and the pagination caveat. Little waste, though the define_interface aside sits slightly awkwardly between the read-only disclaimer and the pagination detail.

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

Completeness3/5

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

For a five-parameter tool with no annotations and no output schema, the description covers behavior and paging but not the return shape or the two required identity parameters (doc_name, part). An agent can call it, but must guess at the response structure and at how part is identified.

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 0% across five parameters, so the description must compensate, and it explains pagination and the offset semantics. However, it names the offsets as next_plane_offset/next_cylinder_offset while the schema calls them plane_offset/cylinder_offset, and it says nothing about doc_name, part, or the exact meaning of feature_limit, leaving two required parameters completely unexplained.

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

Purpose4/5

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

The first sentence names a specific verb (inspect) and the concrete resources returned (valid world-space geometry, planar faces, cylindrical hole candidates), which is far more than a restated name. It does not explicitly differentiate itself from the sibling inspect_region, so the boundary between the two inspection tools is left to inference.

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?

"Start here before assembly work" gives a clear sequencing rule, and naming define_interface as the follow-up for persistent face binding is genuinely useful routing. It also points at feature_counts for full totals, implying the paginated path is for enumeration only, but it never states when inspect_region would be preferred instead.

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