AGENTS.md とは何か

AGENTS.md は、リポジトリのルートに置くコーディングエージェント向けの指示書です。

人間向けの README.md が「このプロジェクトは何か」を説明するのに対し、AGENTS.md は「このリポジトリで作業するときに何を守るか」を説明します。

なぜ必要か

エージェントはリポジトリのコードを読めますが、「なぜそうなっているか」は読めません。暗黙のルールが人間の記憶の中にしかないと、エージェントは毎回それを踏み外します。

最低限そろえる4つのセクション

1. コマンド

エージェントが最初に必要とする情報です。パッケージマネージャを固定していることも明記します。

bash
pnpm install
pnpm build
pnpm typecheck

2. コーディング規約

「フォーマッタが直せること」は書かなくて構いません。フォーマッタでは表現できない判断だけを書きます。

  • 公開関数には明示的な戻り値型をつける
  • 早期リターンでネストを浅くする

3. やってはいけないこと

これがもっとも効きます。禁止事項は具体的に書きます。

  • 本番データベースに直接接続しない
  • 承認なく依存パッケージを追加しない

4. 検証

「完了」の定義を明文化します。

bash
pnpm typecheck
pnpm build

書くべきでないこと

リンドくんリンドくん

情報を詰め込みすぎると、逆に読まれなくなります。

  • コードを読めば分かること（ディレクトリの一覧など）
  • 頻繁に変わる事実（バージョン番号を本文に直書きするなど）
  • 一度きりの作業メモ

長い指示書より、短くて正確な指示書のほうが機能します。

ジェネレーターを使う

FRKZ の AGENTS.md ジェネレーター は、この構成にそった雛形をブラウザ上で生成します。入力内容はサーバーに送信されず、生成結果はそのままコピーしてリポジトリに置けます。

AGENTS.md を生成する