Back to Examples

Complete AGENTS.md for Next.js + TypeScript

A production-grade AGENTS.md used by real teams. Covers principles, skills, workflows, and review standards.

Agent Setup•Beginner•markdown
Example Code
# AGENTS.md

## Project
Modern Next.js 16 + TypeScript + Tailwind + shadcn/ui application. Server Components first, minimal client JS.

## Core Principles
- Small, focused modules and components
- Excellent error messages and logging
- Write tests for any non-trivial logic
- Prefer server actions and streaming over client state when possible
- Update this file when team conventions change

## Available Skills
- advanced-code-reviewer
- test-writer
- multi-file-refactor
- doc-generator
- git-workflow
- debug-analyzer

## Standard Workflow
1. Explore the relevant code first (targeted reads, or the context-builder skill)
2. Write a short plan in scratch.md (never skip)
3. Implement + add or update tests
4. Run the advanced-code-reviewer skill on your changes
5. Create a conventional commit + high-quality PR description

## Handoff Rules
When handing work to another agent or human:
- Include the plan you followed
- List open questions and confidence level
- Point to the exact files changed and tests added

## Forbidden Patterns
- Never use `any` in TypeScript (use unknown + type guards)
- Never mutate props or context directly
- No new dependencies without discussion

When to use this

A production-grade AGENTS.md used by real teams. Covers principles, skills, workflows, and review standards.

Quick Info
Difficulty: Beginner
Language: markdown
Copy the block above and adapt it to your project.