Get Compliance Report
get_compliance_reportGenerate a read-only compliance gap-analysis report for a framework at model or tag scope, classifying each requirement as covered, partial, uncovered, unmapped, or excluded.
Instructions
Compliance gap-analysis report for one framework at a chosen scope. Read-only; no side effects. Requires PRO tier.
Evaluates every framework requirement against the mapped controls in scope and classifies each as covered, partial, uncovered, unmapped, or excluded, then returns coverage counts plus per-requirement rows. The framework must first be activated at the same scope via select_compliance_frameworks (with the matching scope), otherwise there is nothing to report on.
scope selects the boundary and how scope_id is read:
"model"— a single threat model (scope_id= model id)."tag"— rolled up across every member model of a tag (scope_id= tag id).
Filtering / pagination:
level— level filter for level-aware frameworks; returns only requirements at or below this level (e.g. 1 for L1 only). Omit (or 0) for all levels. Honored for all scopes.status— one of "covered", "partial", "uncovered", "unmapped", "excluded"; empty = all statuses. Model scope only.offset/limit— per-requirement row pagination; offset skips the first N rows, limit caps rows returned (0 = no explicit limit). Model scope only.
A tag report is neither paginated nor status-filtered; passing status, offset, or limit with scope="tag" raises an error rather than silently returning unfiltered rows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| level | No | optional level filter; omit for all levels. | |
| limit | No | max requirement rows to return, 0 = no explicit limit (model scope only). | |
| scope | Yes | report boundary — "model" or "tag". | |
| offset | No | skip the first N requirement rows, pagination (model scope only). Default 0. | |
| status | No | optional per-requirement status filter (model scope only). | |
| scope_id | Yes | id of the model or tag selected by ``scope``. | |
| framework_id | Yes | framework to report on (already selected at this scope; see ``list_compliance_frameworks``). | |
| server_version | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||