create-agents-md

AGENTS.md の作成

プロジェクト固有のインラインルールを記述する AGENTS.md ファイルの作成ガイドです。

AGENTS.md を使用する場合

• リポジトリにコミットする、小規模なプロジェクト固有の指示
• 特定のディレクトリに適用するフォルダー単位のルール
• モノレポ内のパッケージ固有の指示
• テストディレクトリ内のテスト固有のガイダンス

AGENTS.md を使用しない場合

• プロジェクト間で再利用できるナレッジ → スキルを使用します
• 大規模なドキュメント → 参照資料付きのスキルを使用します
• 複雑なワークフロー → スクリプト付きのスキルを使用します

AGENTS.md の構成

AGENTS.md は、メタデータを含まないシンプルな Markdown ファイルです。

# Project Instructions

## Code Style

- Use TypeScript for all new files
- Prefer functional components in React
- Use snake_case for database columns

## Architecture

- Follow the repository pattern
- Keep business logic in service layers

配置場所

• プロジェクトルート：AGENTS.md – プロジェクト全体を対象とする主要なインライン指示と参照情報（コマンド、技術スタック、テスト、コードスタイル、アーキテクチャ、安全上の境界）。
• サブディレクトリ：subdirectory/AGENTS.md – ローカルの動作がルートと明確に異なる場合に使用する、フォルダーまたはパッケージ単位の指示（特定のパッケージ、サービス、テストツリーなど）。
• 入れ子になったサポート：エージェントは通常、最も近い AGENTS.md と親の指示を組み合わせます。ルートの内容は一般的なものにし、より具体的なルールが本当に必要な場合に限り、入れ子の AGENTS.md を使用してください。

ベストプラクティス

• AGENTS.md ファイルは小さく、内容を絞ってください
• プロジェクト固有の規約に使用してください
• 長い説明よりも、短く具体的な参照を優先してください：
  • プロジェクトのドキュメント、仕様、運用手順書へのリンクを記載します
  • 例となるファイルやディレクトリを示します（例：see src/api/users.ts for canonical pattern）
  • 重要なコマンドは、正確な CLI 呼び出しとともに記載します
• 可能であれば、既存のコード例を参照してください
• プロジェクトの進化に合わせて更新してください

参考資料

詳しいベストプラクティスについては、references/best-practices.md を参照してください。