Agents md
Agents Skills
npx -y skills add pantheon-org/tekhne --skill agents-mdAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 9 stars9 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Create and maintain AGENTS.md documentation for simple projects, complex monorepos, deterministic discovery, scoped instruction files, low-token navigation; use when generating AGENTS.md, updating agent docs, standardizing AI-facing project guidance.
SKILL.md
3.7 KB, as published. Nobody here has run it
AGENTS.md Management
When to Use
- "Create AGENTS.md for this repo."
- "Update agent documentation for this monorepo."
- "Set up hierarchical AGENTS.md files by package."
When Not to Use
- Pure code implementation work with no documentation update.
- One-off prompts where repository guidance files are unnecessary.
Principles
- Keep instructions concise, concrete, and path-specific.
- Prefer references and indices over duplicated prose.
- Optimize for nearest-file relevance in hierarchical layouts.
Workflow
- Discover repository shape and technologies. Output: simple vs hierarchical documentation strategy.
- Select structure (single root file or root + sub-files). Output: file layout plan.
- Generate AGENTS.md content with concrete commands and paths. Output: actionable docs with JIT indexing.
- Validate command correctness and duplication boundaries. Output: clean, copy-paste-safe instruction files.
- Re-check after major repo changes. Output: synchronized documentation.
Structure Decision
- Simple project: one AGENTS.md when stack and patterns are uniform.
- Complex monorepo: root AGENTS.md + scoped subdirectory AGENTS.md files.
- Consider adding subdirectory files iteratively — start minimal, expand as complexity grows.
Minimal Template
# Project Agent Guide
## Commands
- Build: `bun run build`
- Test: `bun run test`
- Lint: `bun run lint`
## Conventions
- [describe key patterns here]
## Key Paths
- Source: `src/`
- Tests: colocated `*.test.ts`
Quick Commands
# Discovery baseline
rg --files
# Detect core config/tooling
rg -n "workspaces|nx|turbo|pnpm|yarn|packageManager|tsconfig|pytest|playwright" .
# Locate existing AGENTS files
find . -name AGENTS.md -o -name AI-DOCS.md
Anti-Patterns
NEVER assume a technology stack without discovery
WHY: incorrect assumptions produce unusable instructions. BAD: generate React/Jest guidance without evidence. GOOD: run discovery commands and map docs to detected stack.
NEVER dump encyclopedic content into root AGENTS.md
WHY: oversized docs increase token cost and reduce usability. BAD: embed full framework manuals. GOOD: keep root concise and link to scoped files/references.
NEVER duplicate the same instructions across root and sub-files
WHY: duplication creates drift and maintenance overhead. BAD: copy/paste identical conventions in every file. GOOD: keep universal rules at root and package-specific rules locally.
NEVER provide unverified commands
WHY: broken commands erode trust and block contributors. BAD: include hypothetical commands. GOOD: include only validated copy-paste commands.
Verification
bunx markdownlint-cli2 "**/AGENTS.md"
bun run lint
References
| Topic | Reference |
|---|---|
| Repository discovery commands | references/discovery-commands.md |
| What to avoid | references/anti-patterns.md |
| API package template | references/api-template.md |
| Design-system template | references/design-system-template.md |
| Database package template | references/database-template.md |
| Testing package template | references/testing-template.md |
| Troubleshooting | references/troubleshooting.md |