Get Threat Model
get_threat_modelRetrieve a threat model by ID to read its trust boundaries, assets, attackers, assumptions, and components, with optional paginated clarifications and inventory completeness data.
Instructions
Get a threat model by ID: its trust boundaries, assets, attackers, assumptions and components. Read-only.
The answers to its questions are counted (clarification_count) and
left out unless include_clarifications=True, which pages them
(clarifications_offset, clarifications_limit: default 50, at most
200; clarifications_next_offset null at the end). A read over 200,000
characters is cut, and cuts says what and how to read it: the
objectives, then the clarifications, then each entity collection,
largest first, kept as rows that name its entities.
include_inventory_completeness=True (latest version only) adds
inventory_completeness: how much of the inventory the claims rest on,
with bounded_by (the entities holding the tier down) and
grounding_gaps, keyed by entity id. Each gap names a ground the
entity lacks (position, privileges, extent, components,
flagged, inherited), a detail, and acts: each act's
mcp_tool and mcp_arguments (that tool's arguments, the entity
named and lists comma-separated; fields is the REST body), a value
in angle brackets being yours to fill. Taking every listed act grounds the entity; a gap with no
act says no act can supply it on this deployment. An attestation an act
names is a judgment (see edit_attacker). null when the record
could not be read.
Important for agents reading model state:
Assets and attackers may carry
deleted: true(soft-deleted). Exclude these when showing "what's in the model now"; include them only when discussing history or offering restore. Restore an entity viarestore_entity (entity_type="asset")/restore_entity (entity_type="attacker").Control objectives may carry
removed: true(tombstone — the (asset, attacker) pair was removed in a later version). Exclude these from coverage math and LLM prompts; they exist to keep CO IDs stable so controls referencing them can be detected as "orphaned" rather than silently rebinding.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | Optional specific version number. Defaults to latest. | |
| model_id | Yes | ID of the threat model. | |
| include_cos | No | Include control objectives inline (default False: the answer carries no ``control_objectives`` key; read them with ``get_control_objectives``). | |
| server_version | Yes | ||
| clarifications_limit | No | Answers per page. | |
| clarifications_offset | No | The first answer of the page. | |
| include_clarifications | No | Include a page of the answers to the model's questions (default False). | |
| include_inventory_completeness | No | Add the completeness record and its ``grounding_gaps`` (default False). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||