doc-scanner
Scans for project documentation files (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and 15+ other formats) and synthesizes guidance. Auto-activates when user asks to review, understand, or explore a codebase, when starting work in a new project, when asking about conventions or agents, or when documentation context would help. Can consolidate multiple platform docs into unified AGENTS.md.
How do I install this agent skill?
npx skills add https://github.com/0xdarkmatter/claude-mods --skill doc-scannerIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill is a documentation management utility that scans for and synthesizes project-level AI guidance files. While it is generally safe, it possesses an indirect prompt injection surface because it reads external file content from the codebase without sanitization.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1/5 files flagged
What does this agent skill do?
Documentation Scanner
Scan for and synthesize project documentation.
When to Activate
- User asks to review, understand, or explore a codebase
- Starting work in a new/unfamiliar project
- User asks about project conventions or workflows
- Before making significant architectural decisions
Instructions
Step 1: Scan for Documentation
Use Glob to search project root:
AGENTS.md, CLAUDE.md, AI.md, ASSISTANT.md,
GEMINI.md, COPILOT.md, CHATGPT.md, CODEIUM.md,
CURSOR.md, WINDSURF.md, VSCODE.md, JETBRAINS.md,
WARP.md, FIG.md, DEVCONTAINER.md, GITPOD.md
Step 2: Read All Found Files
Read complete contents of every documentation file found.
Step 3: Synthesize
Combine information into unified summary:
PROJECT DOCUMENTATION
Sources: [list files found]
RECOMMENDED AGENTS
Primary: [agents for core work]
Secondary: [agents for specific tasks]
KEY WORKFLOWS
[consolidated workflows]
CONVENTIONS
[code style, patterns]
QUICK COMMANDS
[common commands]
Step 4: Offer Consolidation
If 2+ documentation files exist, offer to consolidate:
- Create
.doc-archive/directory - Archive originals with date suffix
- Generate unified AGENTS.md
- Report what was consolidated
Step 5: No Documentation Found
If none found, offer to draft an AGENTS.md with the repo-doctor skill's scaffold. It builds the draft from a sourced deep scan (declared scripts only, landmine questions from git history) instead of guessing:
# run from the repo-doctor skill's directory
python scripts/agents-md.py scaffold --repo path/to/project > AGENTS.draft.md
Priority Order
- AGENTS.md (platform-agnostic)
- CLAUDE.md (Claude-specific)
- Other AI docs
- IDE docs
- Terminal docs
Additional Resources
For detailed patterns, load:
./references/file-patterns.md- Complete list of files to scan./references/templates.md- the consolidation template (merging several platform docs)
The AGENTS.md standard itself (contents, the 150/200-line budget, CLAUDE.md shadowing)
is the repo-doctor skill's references/agents-md-protocol.md. When consolidating, keep
the result to that standard, and if a CLAUDE.md must remain, make its first line
@AGENTS.md: Claude Code reads only the CLAUDE.md files when one exists. To AUDIT or
UPGRADE an existing AGENTS.md, hand off to repo-doctor's agents-md.py audit --diff.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/0xdarkmatter/claude-mods/doc-scanner">View doc-scanner on skillZs</a>