# AGENTS.md Use this file to guide coding agents working in this repository. It is plain Markdown, so keep the sections direct and easy to scan. ## Project Context - Project type: Next.js - Tech stack: Next.js, TypeScript, React, CSS modules - Coding style: Prefer small components, explicit types, accessible UI, and existing project patterns. - AI tool target: Coding agents ## Project Commands - Package manager: npm - Test: `npm test` - Build: `npm run build` - Lint: `npm run lint` ## Converted Instructions Source format: New instructions Inspect the repository before editing. Preserve existing patterns. Run lint and tests before handoff when possible. Summarize changed files and any checks that could not be run. ## Agent Workflow - Inspect nearby files and reuse established project patterns before editing. - Make small, reviewable changes and avoid unrelated churn. - Do not introduce new dependencies unless they clearly reduce complexity. - Preserve unrelated user changes in the working tree. - Before handoff, summarize changed files, validation results, and follow-up risks.
Use the AGENTS.md Generator and Converter to document how coding agents should inspect, edit, test, and hand off work in your repository. Paste existing CLAUDE.md, Cursor Rules, or team notes, then output AGENTS.md, CLAUDE.md, or .cursor/rules/project.mdc from the same source.
Why AGENTS.md Helps
AGENTS.md gives agent workflows a portable source of truth. The public AGENTS.md format is plain Markdown, so it can describe repo layout, validation commands, safety expectations, and handoff style without locking the team into one editor.
Conversion Workflow
Use AGENTS.md when you want portable instructions, CLAUDE.md when the guidance is specifically for Claude Code project memory, and Cursor Rules when the instructions should follow Cursor's scoped .mdc format. Keep the commands and coding rules shared, then adapt the tool-specific workflow section.
Best Practices
Keep instructions stable, avoid secrets, and prefer commands that a developer can run locally. If a command is slow, document both the targeted check and the full release check. For monorepos, put broad guidance at the root and more specific guidance near the package it governs.
FAQ
Is AGENTS.md tool-specific?
No. It is useful as a portable instruction file across different coding agents.
Can I convert CLAUDE.md into AGENTS.md?
Yes. Keep stable repo context, commands, style rules, validation expectations, and handoff rules. Remove Claude-only commands or move them into a separate Claude Code section.
When should I output Cursor Rules instead?
Use Cursor Rules when the instructions need .mdc frontmatter, file globs, or Cursor-specific behavior inside the editor.
What should AGENTS.md avoid?
Avoid private tokens, vague style slogans, outdated commands, and local paths that only work on one developer's machine.