explain_rule
Explains a security finding and its remediation using the scanner's own report, returning the full check details and published fix so you know what the issue means and how to resolve it.
Instructions
Explain what a finding means and how to fix it, from the scan's own report. Returns the check in full and the remediation the scanner published. Prefer this over fetching a rule's help URI: the answer is already on disk, and for a benchmark that URI is often a registration form in front of a PDF.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | path to a results.sarif produced by draugr scan | |
| ruleId | Yes | the rule to explain, in full or by the part that is unambiguous: 4.3.1 finds kube-bench/cis/4.3.1 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| ruleId | Yes | ||
| foundIn | No | where this rule fired, capped | |
| helpUri | No | ||
| description | No | what the check is, in full rather than the truncated line a report shows | |
| remediation | No | how to fix it, as the scanner published it |