Skip to main content
Glama
freecad-mcp-headless

freecad-mcp-headless

by pitbuild

inspect_document

Describe a FreeCAD document's objects, types, key properties, expressions, and timeline order, plus volume, area, bounding box, and solid/face/edge counts.

Instructions

Describe a document: objects, types, key properties, expressions and timeline order.

Each object reports volume, area, bounding box, solid/face/edge counts and any parametric expressions that drive it.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "inspect_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose the shape of the output (per-object volume, area, bounding box, solid/face/edge counts, driving expressions). It omits other behavioral facts: whether the call is read-only, whether it opens or activates a document, and whether it is expensive on large models.

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?

Two sentences, front-loaded with the summary and followed by the per-object detail. No filler; the only mild redundancy is re-listing 'expressions' in both sentences.

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?

Without an output schema, the description usefully sketches the return payload, which is the biggest gap filled. However, for a document-inspection tool with no annotations, it should also state the default target when 'document' is null and confirm the call has no side effects.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter 'document' has 0% schema description coverage and the description adds nothing about it — not whether it is a name, path, or handle, nor what happens when it is omitted (the schema allows null with a default). The most consequential ambiguity in the call is left entirely 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?

Opens with a specific verb and resource ('Describe a document') and enumerates what is reported: objects, types, properties, expressions, timeline order. That distinguishes it from siblings like list_documents, bounding_box or measure, though those alternatives are never named.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use statement and no mention of when not to use it. An agent must infer that this is the general inspection entry point rather than reaching for list_documents, measure or bounding_box, and the description gives no routing signal for those overlaps.

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