Awesome-omni-skill agents-md-generator
Generate AGENTS.md files for software projects by analyzing project structure, dependencies, and tooling. Use when asked to create an AGENTS.md file, document a project for AI agents, or establish project conventions for agent consumption. Triggers on requests like "create AGENTS.md", "generate agent instructions", "document this project for agents", or "add AI agent documentation".
install
source · Clone the upstream repo
git clone https://github.com/diegosouzapw/awesome-omni-skill
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/diegosouzapw/awesome-omni-skill "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/tools/agents-md-generator-do-ob-io" ~/.claude/skills/diegosouzapw-awesome-omni-skill-agents-md-generator-0cd37f && rm -rf "$T"
manifest:
skills/tools/agents-md-generator-do-ob-io/SKILL.mdsource content
AGENTS.md Generator
Generate structured AGENTS.md files by analyzing a project's tools, dependencies, and organization.
Workflow
- Identify project root — Locate
,package.json
,pyproject.toml
, or similar manifestCargo.toml - Analyze dependencies — Extract framework, testing, linting, and build tools from manifest
- Scan structure — Map
,src/
,lib/
, and other key directoriestest/ - Detect quality tools — Identify typecheck, lint, test, and build commands
- Generate AGENTS.md — Output using the template format
Analysis Checklist
Detect Project Type
| Manifest File | Language | Common Frameworks |
|---|---|---|
| JavaScript/TypeScript | React, Next.js, Express, Vite |
/ | Python | FastAPI, Django, Flask |
| Rust | Actix, Axum, Tokio |
| Go | Gin, Echo, Fiber |
/ | Java/Kotlin | Spring, Quarkus |
Identify Quality Tools
Typechecking:
- TypeScript:
tsc --noEmit - Python:
,mypy
,pyrightty check - Rust:
cargo check
Linting:
- JavaScript/TypeScript:
,eslintbiome - Python:
,ruff
,flake8pylint - Rust:
clippy
Testing:
- JavaScript/TypeScript:
,vitest
,jestmocha - Python:
,pytestunittest - Rust:
cargo test
Determine Project Classification
- Library: Exports modules for other packages (has
orexports
config, nolib
)bin - Application: Runnable entry point (has
,main
, or serves HTTP)bin - Tool: CLI utility (has
field or command-line interface)bin
Output Template
Use the following structure exactly:
# <Project Name> <Library|Application|Tool> <1-2 sentence description of what the project does and its purpose> ## Quality Instructions - **Typecheck**: `<command>` — <brief note if needed> - **Lint**: `<command>` — <brief note if needed> - **Test**: `<command>` — <brief note if needed> - **Build**: `<command>` — <brief note if needed> (if applicable) ## Structure - `src/` — <purpose> - `lib/` — <purpose> - `test/` — <purpose> <additional key directories only> ## Technical Stack - **Language**: <primary language and version if relevant> - **Framework**: <main framework if applicable> - **Key Libraries**: <2-4 most impactful dependencies> - **Build Tool**: <bundler or build system>
Generation Guidelines
Be Minimal
- List only directories that matter for understanding the codebase
- Include only the most impactful 3-5 dependencies
- Omit obvious tooling (e.g., don't list
if already listingtypescript
)tsc
Be Specific
- Use actual command invocations, not generic descriptions
- Reference real paths from the analyzed project
- Match the project's actual tooling configuration
Be Concise
- One-line descriptions for directories
- No redundant explanations
- Skip sections that don't apply (e.g., no "Framework" for a pure utility library)
Example Output
# @acme/data-utils Library Lightweight data transformation utilities for parsing, validating, and formatting structured data. ## Quality Instructions - **Typecheck**: `tsc --noEmit` - **Lint**: `eslint --fix src/` - **Test**: `vitest run` - **Build**: `pnpm build` ## Structure - `src/` — Source modules organized by domain (parsers, validators, formatters) - `src/__tests__/` — Unit tests colocated with source ## Technical Stack - **Language**: TypeScript 5.x - **Key Libraries**: zod (validation), date-fns (date formatting) - **Build Tool**: tsup