get_composition_overview
Retrieve composition overview for a threat model, including tree metadata, entity counts, and warnings to assess availability and structure before drilling into sub-resources.
Instructions
Composition index for a model — counts, tree metadata, warnings.
Read-only; no side effects. Cheapest call in the composition surface (~1-2KB). Use it first to learn whether composition is available for this model, where the model sits on the recursive tree (parent + ancestor chain + child ids), how many own vs inherited entities and COs there are per kind, and whether any structural warnings (cycle, parent missing, max depth exceeded) need surfacing before drilling into sub-resources.
Return shape::
{
model_id, model_version, flag_enabled,
tree: {parent_id, ancestor_chain, depth, child_ids},
counts: {
entities: {kind: {own, inherited}, ...},
control_objectives: {total, live, covered, uncovered,
indeterminate, by_origin: {own, cross, inherited}},
reconciliation_candidates: {certain, heuristic},
},
warnings: [str, ...],
}When composition is not available on the backend, the same shape is
returned with all counts zeroed and flag_enabled: false — detect
that rather than handling an error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model_id | Yes | ID of the threat model. | |
| server_version | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||