Skip to content
agents-md logo

AGENTS.md builder

agents-md

Create or update root and nested AGENTS.md files that document scoped conventions, monorepo module maps, cross-domain workflows, and (optionally) per-module feature maps (feature -> paths, entrypoints, tests, docs). Use when the user asks for AGENTS.md, nested agent instructions, or a module/feat...

SKILL.md

Full skill instructions

AGENTS.md builder

Goal

Add lightweight, scoped guidance for an AI agent (and humans) by placing AGENTS.md files at key directory boundaries:

  • root: cross-domain guidance + a module map (for monorepos)
  • nested: tech-specific instructions for each component/​module
  • optional: feature maps at the module level

Optimize for concise and precise instructions (short bullets, minimal prose). Link to docs for depth.

Inputs to ask for (if missing)

  • Is this a monorepo (multiple independently-built modules) or a single project?
  • Repo layout: where backend, frontend, docs, infra live; list the major modules/​subprojects.
  • Cross-domain workflows to document (e.g., frontend calling backend API, auth flow, shared types, local dev).
  • If you want feature maps: top 5-15 user-facing features (names) and which module owns them.
  • Any rules about MCP usage to capture in root AGENTS.md (allowed servers/​tools, safety constraints).
  • Any hard rules (do not touch X, required commands, style rules).

Where to put AGENTS.md (heuristics)

Create AGENTS.md at:

  • repo root (global rules + module map + cross-domain workflows)
  • each major component/​module root (e.g., backend/, frontend/, docs/, infra/)
  • any subdirectory that has different conventions, ownership, or high risk (payments, auth, data migrations)

Avoid placing AGENTS.md too deep unless there is a real boundary; too many files become noise.

Workflow (checklist)

  1. Inventory the repo
    • List top-level directories and build files (Gradle/​Maven, Node/​Next, docs site).
    • Identify the natural "component roots" and any critical submodules.
  2. Draft root AGENTS.md
    • State global rules only (things that apply everywhere).
    • If monorepo: add a module/​subproject map (not a feature map) and links to each nested AGENTS.md.
    • Keep tech-specific instructions out of root; push them into the owning module's AGENTS.md.
    • Docs: do not open/​read docs/ by default; consult only when asked or required.
    • Add cross-domain workflows (how modules connect): frontend <-> backend API, auth/​session, contract location (OpenAPI/​GraphQL), "run together" local dev.
    • Add cross-repo verification guidance: where to run per module + prereqs; quiet first run; re-run narrowed failures with verbose logs when debugging.
  3. Draft nested AGENTS.md per component
    • Put tech-specific instructions in the module that owns them:
      • Backend: how to run, test, migrate DB; key modules and entrypoints.
      • Frontend: how to run, build, test; env vars; key routes/​areas.
      • Docs: docs structure, where to add ADRs/​runbooks, how to preview/​build docs.
  4. Build maps (as needed)
    • If monorepo: module map goes in root (use references/​module-map-format.md).
    • Feature maps should live in the owning module AGENTS.md (use references/​feature-map-format.md).
  5. Verify consistency
    • Ensure guidance does not conflict between parent/​child scopes.
    • Keep each AGENTS.md short and actionable; move long detail into docs under docs/.

Templates

Use these templates:

  • Root + module AGENTS.md: references/​agents-template.md
  • Module map format: references/​module-map-format.md
  • Feature map table format (per module): references/​feature-map-format.md
  • Suggested docs/ layout (Spring + Next): references/​docs-structure.md

Deliverable

Provide:

  • Root AGENTS.md (if requested) with module map and cross-domain workflows.
  • Nested AGENTS.md per component/​module with tech-specific guidance.
  • Optional feature map tables per module (if requested).
  • A list of files created/​updated and any open questions.

More skills from majiayu000

xiaohongshu logo
majiayu000/claude-arsenal

xiaohongshu

xiaohongshu

286 148
View
agent-task-conductor logo
majiayu000/claude-skill-registry

agent-task-conductor

Conduct multi-agent task orchestration and workflow coordination.

663 1
View
conductor-setup logo
majiayu000/claude-skill-registry

conductor-setup

Initialize project with Conductor artifacts (product definition,

663 1
View
animation-designer logo
majiayu000/claude-skill-registry

animation-designer

Expert in web animations, transitions, and motion design using Framer Motion and CSS

663 1
View
diagramming logo
majiayu000/claude-skill-registry

diagramming

Creates Mermaid and ASCII diagrams for flowcharts, architecture, ERDs, state machines, mindmaps, and more. Use when user mentions diagram, flowchart, mermaid, ASCII diagram, text diagram, terminal diagram, visualize, C4, mindmap, architecture diagram, sequence diagram, ERD, or needs visual docume...

663 1
View
h3-pg logo
majiayu000/claude-skill-registry-data

h3-pg

PostgreSQL bindings for H3 hexagonal grid system. Use when working with H3 cells in Postgres, including spatial indexing, geometry/geography integration, and raster analysis.

23 1
View
conductor-development logo
majiayu000/claude-skill-registry

conductor-development

Context-Driven Development skill for projects using Conductor. Use this skill when you detect a `conductor/` directory in the project, when working on tasks defined in a `plan.md` file, or when the user asks about tracks, specs, or plans. Automatically applies TDD workflow, tracks task completion...

663 1
View
conductor-status logo
majiayu000/claude-skill-registry

conductor-status

Display project status, active tracks, and next actions

663 1
View
dockerization logo
majiayu000/claude-skill-registry

dockerization

Official Stakpak application containerization standard operating procedure, a step-by-step guidline to properly dockerize applications. This is a rule book curated by the Stakpak Team.

663 1
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View