Schema Tools¶
Schema tools let agents reason about object structure before editing models.
list_object_types¶
List available object types, optionally filtered by group and version.
Use cases:
- discover object families
- constrain planning space for autonomous agents
describe_object_type¶
Returns detailed field metadata:
- required fields
- defaults
- enums
- min/max constraints
- reference lists
- documentation URL (link to the object's page on docs.idfkit.com)
Detailed field notes are omitted from the response to reduce token overhead. Use search_docs or get_doc_section for in-depth field documentation.
Use this before any add_object or update_object call.
search_schema¶
Find types by name or schema memo text. Each match includes a doc_url linking to the object's documentation page on docs.idfkit.com.
Useful when the agent only has conceptual intent, such as "infiltration" or "internal gains".
get_available_references¶
Given an object type and reference field, returns valid names from current model state.
Typical usage:
describe_object_type("BuildingSurface:Detailed")get_available_references(object_type="BuildingSurface:Detailed", field_name="zone_name")- choose value from
available_names