Codex

mention-report

Generate traceability report from @-mentions

104 stars

byjmagly

View on GitHub Installation ↓

Best use case

mention-report is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

It is a strong fit for teams already working in Codex.

Generate traceability report from @-mentions

Teams using mention-report should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

You only need a quick one-off answer and do not need a reusable workflow.
You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/mention-report/SKILL.md --create-dirs "https://raw.githubusercontent.com/jmagly/aiwg/main/.agents/skills/mention-report/SKILL.md"

Manual Installation

Download SKILL.md from GitHub
Place it in .claude/skills/mention-report/SKILL.md inside your project
Restart your AI agent — it will auto-discover the skill

How mention-report Compares

Feature / Agent	mention-report	Standard Approach
Platform Support	Codex	Limited / Varies
Context Awareness	High	Baseline
Installation Complexity	Unknown	N/A

Frequently Asked Questions

What does this skill do?

Generate traceability report from @-mentions

Which AI agents support this skill?

This skill is designed for Codex.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

Cursor vs Codex for AI Workflows

Compare Cursor and Codex for AI coding workflows, repository assistance, debugging, refactoring, and reusable developer skills.

AI Agents for Coding

Browse AI agent skills for coding, debugging, testing, refactoring, code review, and developer workflows across Claude, Cursor, and Codex.

AI Agents for Marketing

Discover AI agents for marketing workflows, from SEO and content production to campaign research, outreach, and analytics.

SKILL.md Source

# @-Mention Traceability Report

Generate traceability report showing relationships between artifacts.

## Usage

```bash
/mention-report                      # Markdown report to stdout
/mention-report --format json        # JSON format
/mention-report --format csv         # CSV for spreadsheets
/mention-report --output .aiwg/reports/traceability.md
```

## Options

| Option | Default | Description |
|--------|---------|-------------|
| --target | . | Directory to analyze |
| --format | md | Output format: md, json, csv |
| --output | stdout | Write to file |

## Report Sections

### Requirements Coverage

```markdown
## Requirements Coverage

| Requirement | Implemented | Tested | Documented |
|-------------|-------------|--------|------------|
| UC-001 | ✓ src/auth/ | ✓ test/auth/ | ✓ docs/ |
| UC-002 | ✓ src/api/ | ✗ | ✗ |
| UC-003 | ✗ | ✗ | ✗ |

Coverage: 67% implemented, 33% tested, 33% documented
```

### Architecture Traceability

```markdown
## Architecture Traceability

| ADR | Referenced By | Implementation |
|-----|---------------|----------------|
| ADR-001 | 3 files | src/db/ |
| ADR-002 | 5 files | src/auth/, src/api/ |
| ADR-003 | 1 file | src/cache/ |
```

### Security Controls

```markdown
## Security Control Coverage

| Control | Implementation | Verification |
|---------|----------------|--------------|
| AUTHN-001 | src/auth/middleware.ts | test/security/ |
| AUTHZ-001 | src/auth/permissions.ts | ✗ |
```

### Dependency Graph

```markdown
## Dependency Graph

UC-001 (User Authentication)
├── ADR-005-jwt-strategy.md
├── src/services/auth/
│   ├── login.ts
│   ├── logout.ts
│   └── refresh.ts
├── test/integration/auth/
└── docs/api/auth.md
```

## JSON Format

```json
{
  "generated": "2025-01-15T10:30:00Z",
  "summary": {
    "total_mentions": 142,
    "requirements": { "total": 15, "covered": 12 },
    "adrs": { "total": 8, "referenced": 6 }
  },
  "traceability": [
    {
      "artifact": ".aiwg/requirements/UC-001.md",
      "type": "requirement",
      "referenced_by": ["src/auth/login.ts", "test/auth/login.test.ts"],
      "coverage": { "implemented": true, "tested": true, "documented": true }
    }
  ]
}
```

## CLI Equivalent

```bash
aiwg mention-report [--format md|json|csv] [--output <file>]
```

## Related Commands

- `/mention-wire` - Add @-mentions
- `/mention-validate` - Validate @-mentions
- `/check-traceability` - Full traceability verification

Generate report for: $ARGUMENTS

## References

- @$AIWG_ROOT/agentic/code/addons/aiwg-utils/README.md — aiwg-utils addon overview
- @$AIWG_ROOT/docs/cli-reference.md — CLI reference for mention-report command
- @$AIWG_ROOT/agentic/code/addons/aiwg-utils/rules/research-before-decision.md — Scan codebase before reporting
- @$AIWG_ROOT/agentic/code/frameworks/sdlc-complete/README.md — SDLC artifact structure for traceability reporting