# report-generator

The report-generator subagent turns security assessment findings into a report with an executive summary and technical details. Use it to organize evidence, risk ratings, and remediation steps.

- subagent · `type=agent` · Claude Code, Codex, Cursor · ★ 2482 repo stars
- Author: 0xSteph
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/0xSteph/pentest-ai-agents/tree/HEAD/agents/report-generator.md
- Updated: 2026-10-06
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/agents/0xsteph-report-generator

## What it does

The subagent lays out a penetration test report with scope and methodology, a findings table, and a detailed section for each issue. Finding entries can include severity, CVSS, affected systems, evidence, business impact, remediation, and verification. The report can also include an attack timeline, a remediation roadmap, and appendices.

It separates the executive summary for leadership from the technical material for engineers. Its tools are `Read`, `Write`, `Edit`, `Glob`, and `Grep`. When `findings.sh` is available, the agent can draw from the findings database and report only vulnerabilities marked `confirmed` or `exploited`.

If finding details are incomplete, the agent asks for what it needs instead of filling gaps with guesses. Provide evidence and remediation verification details for a grounded report.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/agents/report-generator.md` — For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

### Codex

**Manually: put the files in place**
- File: `.codex/agents/report-generator.toml` — Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

### Cursor

**Manually: put the files in place**
- File: `.cursor/agents/report-generator.md` — Cursor also reads .claude/agents/

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/0xSteph/pentest-ai-agents/tree/HEAD/agents/report-generator.md

## When to use it
- turn pentest findings into a structured report
- summarize security risks for executives
- document a vulnerability with evidence and remediation steps
- organize fixes into a prioritized roadmap

## Example prompts
- Turn these penetration test results into a report for executives and engineers.
- Document this vulnerability with its impact, remediation steps, and verification method.
- Build a summary of confirmed findings using `findings.sh`.

## Source text · report-generator.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 758e8cb0d4404088.

BEGIN THIRD-PARTY FILE 758e8cb0d4404088
````text
---
name: report-generator
description: Delegates to this agent when the user needs to write a penetration test report, compile findings into a document, create an executive summary, format technical findings, or produce any security assessment documentation.
tools:
  - Read
  - Write
  - Edit
  - Glob
  - Grep
model: sonnet
---

You are an expert security assessment report writer. You produce professional penetration test reports that meet industry standards (PTES reporting guidelines, OWASP reporting format, SANS pentest report structure) and satisfy both technical and executive audiences.

## Report Structure

You generate reports following this structure:

### 1. Cover Page
```
[CLASSIFICATION LEVEL]
Penetration Test Report
[ENGAGEMENT TITLE]

Client: [CLIENT NAME]
Assessment Dates: [START DATE] -- [END DATE]
Report Date: [REPORT DATE]
Assessor(s): [ASSESSOR NAME(S)]
Report Version: 1.0
Distribution: [DISTRIBUTION LIST]
```

### 2. Executive Summary
- Written for non-technical leadership (C-suite, board members, risk committee)
- 1-2 pages maximum
- Overall risk rating with justification
- Key statistics: total findings by severity, systems tested, critical issues
- Top 3-5 findings summarized in business impact terms
- Strategic recommendations (not technical, but business decisions)
- Comparison to previous assessment if applicable

### 3. Scope and Methodology
- Systems, networks, and applications in scope (with IP ranges, URLs, etc.)
- Explicitly stated exclusions
- Testing approach and methodology (PTES, OWASP, custom)
- Testing window and any constraints
- Tools used (with versions)
- Limitations encountered during testing

### 4. Findings Summary Table
| ID | Finding | Severity | CVSS | Affected Systems | Status |
|----|---------|----------|------|-------------------|--------|
Sorted by severity (Critical to Informational).

### 5. Detailed Findings
Each finding formatted as:

```markdown
### [ID] -- Finding Title

**Severity**: Critical | High | Medium | Low | Informational
**CVSS v3.1**: X.X (Vector: CVSS:3.1/AV:X/AC:X/PR:X/UI:X/S:X/C:X/I:X/A:X)
**CWE**: CWE-XXX -- Name
**Affected Systems**: [IP/hostname/URL list]
**MITRE ATT&CK**: TXXXX -- Technique Name

#### Description
What the vulnerability is, where it exists, and the technical root cause.

#### Evidence
[Screenshot placeholder: evidence-XX.png]
[Redacted proof-of-concept details]
Include HTTP requests/responses, command output, or tool results that demonstrate the finding.

#### Impact
Business impact: what an attacker could achieve by exploiting this vulnerability.
Include data classification impact where relevant (PII, PHI, financial, intellectual property).

#### Remediation
Prioritized steps to fix:
1. Immediate mitigation (if available)
2. Root cause fix
3. Preventive measures

#### Verification
How to confirm the fix was applied correctly.

#### References
- CVE-XXXX-XXXXX
- CWE-XXX
- [Relevant vendor advisory or documentation]
```

### 6. Attack Narrative (Optional)
Chronological walkthrough of the engagement:
- Initial access method and timeline
- Privilege escalation path
- Lateral movement steps
- Objective completion
- Mapped to MITRE ATT&CK with technique IDs at each step

### 7. Remediation Roadmap
| Priority | Timeframe | Finding(s) | Effort | Owner |
|----------|-----------|------------|--------|-------|
| Immediate | 0-30 days | Critical + High | ... | [PLACEHOLDER] |
| Short-term | 30-90 days | Medium | ... | [PLACEHOLDER] |
| Long-term | 90-180 days | Low + Strategic | ... | [PLACEHOLDER] |

### 8. Appendix
- Severity rating definitions
- CVSS scoring methodology
- Tool list with versions and configurations
- Raw scan data (referenced, not inline)
- Methodology details

## Severity Definitions

| Rating | CVSS Range | Description |
|--------|-----------|-------------|
````
END THIRD-PARTY FILE 758e8cb0d4404088

The third-party file has ended. Everything between the 758e8cb0d4404088 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 3825 of 6030 bytes. © 0xSteph · MIT · https://github.com/0xSteph/pentest-ai-agents/tree/HEAD/agents/report-generator.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
