Agent quickstart

​

First calls

1. Call list_documents if the active document name is unknown.
2. Call get_world_state with include_feature_tree=true and include_geometry=true.
3. If target identity is ambiguous, call take_snapshot and use uid, object name, or Object#FaceN selectors in later calls.
4. If the task changes geometry or data and the chosen tool accepts transaction_id, open a transaction with transaction_create.
5. Mutate with the narrowest typed tool. Use execute_code only when no typed MCP tool covers the operation.
6. Recompute or rely on the tool’s recompute option.
7. Inspect with get_world_state and render with get_view or get_ortho.
8. Validate with check_objects, check_geometry, verify_solid, or validate_document.
9. Apply or cancel the transaction. Report object names, dimensions, validation status, and any residual uncertainty.

​

Minimal mutation template

get_world_state(doc_name?, include_feature_tree=true, include_geometry=true)
transaction_create(doc_name, label, reason)
create_object/edit_object/delete_object/insert_part_from_library/execute_code(..., transaction_id)
transaction_plan(transaction_id)
transaction_apply(transaction_id)
get_ortho(focus_object?, display_mode?)
validate_document(doc_name, deep_geometry=true, run_bop_check=true)

​

Minimal Python template

import FreeCAD
import Part

doc = FreeCAD.ActiveDocument
if doc is None:
    doc = FreeCAD.newDocument("Model")
obj = doc.addObject("Part::Box", "ReferenceBlock")
obj.Length = 40
obj.Width = 20
obj.Height = 10
doc.recompute()