Skip to content
Skillpedia
Agents48k · #2075

agents-generator

Generates AI agent documentation from code. Helps create AGENTS.md files and rules describing the agent and how it works.

What it does

This agent creates a file named `AGENTS.md` and other rule files for your programming project. It analyzes your code to understand the tools you use and generates custom instructions to help other AI agents work on your project.

When to use it

  • ✓When you want to create a detailed guide for AI agents about your project.
  • ✓To generate specific rules for technologies like testing, databases, or frameworks.
  • ✓To update your project's guide if you've changed tools or structure.

Example of what to ask your AI

“Create a full `AGENTS.md` and rules for my project.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/agents-generator/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/agents-generator/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

It first identifies the tools your project uses (like Node.js, React, etc.) and then writes an `AGENTS.md` file and rule files (`.agents/rules/`) based on that information. It ensures the instructions are specific to your project, not generic.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add sickn33/agentic-awesome-skills --skill agents-generator

Or download just the file:

curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/agents-generator/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Skill: agents-generator

[!WARNING] [Authorized Use Only] This skill writes or updates AGENTS.md, .agents/rules/, optional platform instruction files, and timestamped backups in the target project. Read the detected inputs and proposed outputs first, obtain approval before changing target files, and use it only inside the user's intended project scope.

When to Use

Use this skill when the user wants to:

  • create a complete, project-specific AGENTS.md instead of generic agent rules;
  • generate companion rules for detected frameworks, tests, databases, styling, or monorepo packages;
  • create a minimal AGENTS.md, preview changes without writing, or update existing instructions after the stack changes.

Do not use it to invent conventions without inspecting the target project, to overwrite instructions outside the user's scope, or to treat generated guidance as a substitute for human review.

Generates a tailored AGENTS.md + .agents/rules/*.md for the target project — not a template with placeholders, but a living document that matches the project's real toolchain.

What you get

From a project that uses Bun + Next.js 16 + Tailwind + Vitest + Server Actions, the skill produces:

AGENTS.md
├── Setup commands: bun install, bun dev, bun run test:run, bun doctor
├── Verification Cycle: bunx tsc --noEmit → bun run lint → bun run test:run → bun doctor
├── Conventions: "Bun always. Plain TypeScript types + guards."
└── Architecture → .agents/rules/architecture.md

.agents/rules/
├── architecture.md       ← ASCII diagram with real directories, exact versions
├── frontend-patterns.md  ← Component rules, state locations, trust boundaries
├── server-actions.md     ← downloadVideo() flow, DownloadResult type, rate limiter
├── testing.md            ← "74 tests in 5 files", vitest commands, mock patterns
├── git-workflow.md       ← Conventional commits, pre-commit checks
└── sdd-workflow.md       ← Preflight defaults, post-apply verification

Rules NOT generated: backend.md (no NestJS), database.md (no ORM), i18n.md (hardcoded Spanish), forms.md (manual inputs), styling.md (Tailwind in frontend rules).

Activation Contract

Generate AGENTS.md + .agents/rules/*.md for the target project. Never guess — read the project's actual files first.

Mode selection

User says Mode Output
"simple AGENTS.md", "just the basics", "minimal" Minimal Single AGENTS.md (~30 lines, no rule files)
"full AGENTS.md", "with rules", "complete", or default Full AGENTS.md + .agents/rules/*.md
"update AGENTS.md", "refresh", "my stack changed" Update Diff existing, regenerate only what changed

Dry-run mode

If the user asks to "preview", "show what would change", "dry-run": run all detection but do NOT write files. Show detection summary, files that would be created, skipped rules, and sample output.

Hard Rules

  • Read before writing, but never read secrets. Read package.json, non-secret config files, and directory structure before generating anything. Never open .env, .env.local, credential stores, or similarly secret-bearing files. Derive environment variable names only from .env.example placeholders and source references such as process.env.NAME, without reading or reporting values.
  • Detect package manager FIRST. Check lockfiles: bun.lock→bun, pnpm-lock.yaml→pnpm, package-lock.json→npm, yarn.lock→yarn. NEVER default to npm. Every command uses the detected PM.
  • Generate only what applies. No backend rules for frontend-only. No database rules without ORM.
  • Do not execute project scripts by default. Package-manager scripts are repository-controlled shell entry points. Detect and document candidate format/lint commands, but do not run them unless the user separately requests execution after the exact script body and invoked tooling have been reviewed.
  • Validate commands. Every command in output must exist as a script key in package.json.
  • No placeholders. Scan output for {{, TODO, add here, .... Reject if any remain.
  • Backup first. If files exist, copy to .agents/backups/ with timestamp.

Execution Steps

Common

  1. git rev-parse --show-toplevel → project root.
  2. Detect package manager FIRST: check lockfiles. bun.lock→bun, pnpm-lock.yaml→pnpm, package-lock.json→npm, yarn.lock→yarn. Never default to npm.

…

FAQ

What is `AGENTS.md`?

It's a file that contains instructions for AI agents on how to work on your specific project, including which tools to use and how to follow your conventions.

What are the files in `.agents/rules/`?

These are additional files that detail specific rules for parts of your project, such as testing, frontend, backend, or workflow.

Can it create rules for any technology?

It only creates rules for technologies it detects in your project. If a technology isn't present, it won't generate a rule for it.

Details

Original description by the author

Generate project-specific AGENTS.md and companion rules by analyzing a codebase. Supports full, minimal, update, and dry-run modes with package-manager detection, monorepos, backups, managed blocks, confidence scoring, and command validation.

repo: sickn33/agentic-awesome-skills

Popularity

GitHub stars
48k
Ranking position
#2075
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills