detection-report

Generates Markdown reports summarizing detection rule logic, alert performance, and tuning context.

85|14|Updated May 17, 2025
One-click install
npx skills add https://github.com/dandye/adk_runbooks --skill detection-report-dandye
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: detection-report
Source: https://github.com/dandye/adk_runbooks/tree/main/skills/reporting/detection-report
Command: npx skills add https://github.com/dandye/adk_runbooks --skill detection-report-dandye

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Security teams need periodic documentation of detection rule coverage, alert volume, and true/false positive rates, but manually compiling rule definitions, SIEM alert history, and SOAR case context into a consistent report is slow and error-prone. ## Core Features & Use Cases - Rule and Performance Retrieval: Pulls rule definitions via secops-mcp list_security_rules and historical alert statistics via get_security_alerts over a configurable timeframe (default 90 days). - SOAR Context Integration: Optionally enriches the report with related case details and tuning notes from secops-soar when a case ID is provided. - Standardized Markdown Output: Structures findings into a report template with rule details, performance metrics, and recommendations, plus a Mermaid sequence diagram, saved via write_to_file. - Use Case: A detection engineer needs a quarterly review of a noisy YARA-L rule; the skill gathers 90 days of alert data, correlates a tuning case, and writes detection_report_<RULE_ID>_<timestamp>.md. ## Quick Start Generate a detection report for rule RULE_ID covering the last 90 days of alerts and save it as a Markdown file.

Frequently Asked Questions about detection-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a detection rule performance report?▼

Provide the rule ID and an optional timeframe in days; the workflow retrieves the rule definition with list_security_rules, gathers alert history with get_security_alerts, and writes a Markdown report to ./reports/ using write_to_file.

What data sources are used for detection reporting?▼

The report uses secops-mcp for rule definitions and historical security alerts, and optionally secops-soar get_case_full_details for case context and true/false positive rates when a case ID is supplied.

Can I report on multiple detection rules at once?▼

Yes, the workflow accepts RULE_IDS as a list and iterates through each rule to gather definitions and performance data, adjusting the output filename accordingly.

Does this runbook tune or modify detection rules?▼

No, it explicitly excludes performing new validation, tuning, or rule changes. It only reports on existing rule definitions, historical performance, and prior tuning documentation.

What is the default timeframe for alert performance data?▼

The default is 90 days when REPORT_TIMEFRAME_DAYS is not specified. The value is converted to hours for the get_security_alerts query.