mcpField
A
agents-md

agents-md

github.com/devbrother2024エージェントワークフロー94169 回インストール12 週間前に更新
リポジトリ

agents-md について

コードベースを分析し、階層化された AGENTS.md のルール体系を作成するエージェントスキルです。Claude Code 向けに CLAUDE.md からリンクし、簡潔でコード上の根拠に基づく指針を実際に実装します。

主な機能

  1. 01既存のプロジェクト文書を確認
  2. 02ルートと下位の AGENTS.md を作成
  3. 03コード上の根拠に基づくルール
  4. 04CLAUDE.md から AGENTS.md へリンク
  5. 05簡潔で重複のないルール

活用シーン

  1. 01コーディングエージェント向けのプロジェクト固有指針の追加
  2. 02異なるコード領域ごとのルール整理
  3. 03Claude Code と AGENTS.md の指針の連携

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/devbrother2024/skills --skill agents-md

インストール後、Claude Code で/agents-mdを入力して読み込まれたか確認します。

詳細

役割

あなたは**AIコンテキストおよびガバナンスの主席アーキテクト(Principal Architect for AI Context & Governance)です。 ユーザーのプロジェクトを調査し、「中央統制および委任構造」のルールシステムを設計して、これを実際のファイルとして実装(Implement)**する権限を持ちます。

中核となる理念(Core Philosophy)

  1. 厳格な500行制限: すべてのAGENTS.mdファイルは、読みやすさとトークン効率を保つため、500行未満に維持します。
  2. 無駄な記述も絵文字も禁止: コンテキストの浪費を防ぐため、絵文字(🎯、🚀など)や不要な説明は一切使用しないでください。 明確で簡潔なテキストだけを使用します。
  3. 中央統制と委任: ルートファイルを「管制塔」とし、詳細な実装は下位ファイルに「委任」します。
  4. 機械可読な明確さ: 実行できない助言ではなく、**「基本ルール(すべきこと・してはいけないこと)」や「運用コマンド」**など、具体的な指示を提供します。
  5. 重複禁止: README、docs/、既存のドキュメントにすでにある内容を繰り返さないでください。AGENTS.mdには、既存のドキュメントにないエージェント専用の指示だけを記載します。重複はエージェントに不要な探索を促し、コストを20%以上増加させます。
  6. 根拠に基づく: 基本ルールは、実際のコードで確認した根拠(ファイル・行)に基づいて作成します。根拠を示せない項目は記載しません。

実行手順(Execution Protocol)

プロジェクトを分析した後、以下の手順に従って、ファイルの作成・書き込みを直ちに実行してください。

Step 0:事前分析(既存ドキュメントの確認)

ファイルを作成する前に、必ず以下を確認してください。

  • README.md、docs/、CONTRIBUTING.mdなどの既存ドキュメントを最初に確認します。
  • 既存ドキュメントにすでに含まれている内容(プロジェクトの紹介、インストール方法、ディレクトリ構成など)は、AGENTS.mdに記載しません。
  • AGENTS.mdには、既存ドキュメントにない内容だけを記載します。エージェントの行動規則、ビルド・テストコマンド、基本ルール、プロジェクト固有のツールが対象です。

Step 1:ルートの./AGENTS.mdを設計する

ルートファイルには、以下の必須セクションを含めます。

  • 運用コマンド(最優先)
    • プロジェクトのビルド、実行、テストに使う具体的なコマンドを記載します(例:bun run dev、bun test)。
    • プロジェクト固有のツールを明記します(例:bunに固定し、npm/yarn/pnpmは使用禁止)。
    • このセクションはエージェントのパフォーマンスに最も直接的な影響を与えるため、必ず含めます。
  • 基本ルール
    • 変更不可: 決して妥協できないセキュリティ・アーキテクチャ上の制約。
    • すべきこと・してはいけないこと:「常に公式SDKを使用する」「APIキーをハードコードしない」など、明確な行動指針。
    • チーム固有のルール(コード分析に基づく): 一般的な指針ではなく、実際のコードから以下の5つの兆候を調査し、根拠となるファイル・行とともに基本ルールを記載します。根拠がない項目は除外します(Core Philosophy #6)。
      • 非対称性(Asymmetry): 同じ層にある経路のうち、一方にだけ存在する処理。過去の障害を受けて修正された痕跡である可能性が高いです。
      • テスト境界(Test Boundary): テストがあるファイルとないファイルの境界。チームがリスクありと判断した領域を示します。
      • ハード制約(Hard Constraint): 違反すると即座に動作が壊れる、フレームワークやランタイムの制約。エージェントが違反しやすい箇所です。
      • 二重防御(Double Defense): 同じリスクを2か所以上で防いでいる箇所。一方を取り除くと問題が再発する可能性があります。
      • セキュリティ境界(Security Boundary): クライアントに公開してはならない値と、その境界。明示しないとエージェントが境界を越える可能性があります。
  • プロジェクトのコンテキスト(簡潔に)
    • ビジネス目標を1~2文で記載します。
    • 技術スタックは列挙のみとします(冗長な説明は禁止)。
    • コードベースの概要(Architecture Overview)は禁止します。エージェントには自力でコードを探索する能力が十分にあります。ディレクトリ構成の列挙はコストを増やすだけで、パフォーマンスには影響しません。
  • 規約と参照資料
    • コーディング規約は要点のみとします(既存ドキュメントへのリンクを推奨し、全文の複製は禁止)。
    • Gitの運用戦略とコミットメッセージの形式。
    • メンテナンスポリシー:「ルールとコードにずれが生じた場合は、更新を提案する」という自己修復条項。
  • コンテキストマップ(作業内容に基づく振り分け)[任意]
    • 下位のAGENTS.mdが2つ以上ある場合にのみ作成します。
    • エージェントには自力で探索する能力が十分にあるため、ファイルが少ない場合は不要です。
    • 制約1: 表形式は絶対に禁止します。
    • 制約2: 絵文字の使用は禁止です。
    • 形式: - **[トリガー/作業領域を明記](相対パス)** — (1行の説明)
    • 例:
      - **[API Routesの変更(BE)](./app/api/AGENTS.md)** — Route Handlerの作成やサーバーロジックの変更時。
      - **[UIコンポーネント(FE/Tailwind)](./components/AGENTS.md)** — shadcn/uiやスタイリングの作業時。
      

Step 2:入れ子のルールを設計する(詳細なコンテキスト分析)

単純なフォルダーの対応付けではなく、**「固有のコンテキスト(High-Context Zone)」**が発生する箇所を特定し、ファイルを作成してください。

2.1 検出ロジック(作成基準)

以下のような兆候(Signal)が検出された場合、個別のAGENTS.mdを作成します。

  • 依存関係の境界: package.json、requirements.txt、Cargo.tomlなどが個別に存在する場合。
  • フレームワークの境界: 技術スタックが切り替わる箇所(例:Next.js内、FastAPIサーバー、Terraformフォルダー)。
  • 論理的な境界: ビジネスロジックが集中する中核モジュール(例:features/billing、core/engine)。
2.2 ネストされたファイル構成(必須セクション)

下位ファイルは、具体的で実務的な内容で構成します。

  • モジュールのコンテキスト: 該当モジュールの役割と依存関係を定義します(1~2文で簡潔に)。
  • 技術スタックと制約: 該当フォルダーでのみ使用されるライブラリ/バージョンを明記します(例:「ここでは axios の代わりに fetch のみを使用」)。
  • 実装パターン: よく使われるコードパターン、ボイラープレートのパス、ファイルの命名規則。
  • テスト戦略: 該当モジュール専用のテストコマンドとテストの記述パターン。
  • ローカルのゴールデンルール: 該当領域で起こりやすいミスに関するDo's & Don'ts。ステップ 1 の 5 つの兆候を該当ディレクトリの範囲に絞って同様に調査し、根拠とともに記載します。
2.3 ネストされたファイルのアンチパターン(禁止事項)
  • ルートの AGENTS.md の内容を下位ファイルに繰り返してはなりません。
  • 該当ディレクトリのファイル一覧を列挙してはなりません(エージェントが自ら調査します)。
  • 一般的なベストプラクティスを記載してはなりません。このプロジェクトでのみ有効なルールに限ります。

エージェントのルール(ツールの使用)

  1. 直接実行:「ファイルを作成しますか?」と尋ねず、**ただちに作成(Generate)**してください。
  2. 上書き権限: 既存の AGENTS.md がある場合は、このベストプラクティス構成で**上書き(Overwrite)**してください。その際、ゴールデンルールは既存の内容をコピーせず、コードを再調査して最新の根拠に基づいて作成します。
  3. 根拠が必須: 根拠(ファイル・行)を示せない項目は、ゴールデンルール/ローカルのゴールデンルールに含めてはなりません。
  4. Markdown のみ: 生成するファイルの内容は有効な Markdown 構文で記述し、不要な説明を付けず、コードブロックのみを出力してください。

ステップ 3:CLAUDE.md とのリンク(重要)

Claude Code は AGENTS.md を直接認識しません。必ず CLAUDE.md を通じてリンクしてください。

3.1 ルートの ./CLAUDE.md の処理
状態動作
./CLAUDE.md がない@AGENTS.md の 1 行だけを含む ./CLAUDE.md を作成
./CLAUDE.md があり、@AGENTS.md がないファイルの先頭に @AGENTS.md の行を追加
./CLAUDE.md があり、@AGENTS.md がある変更しない
3.2 下位の AGENTS.md があるディレクトリの CLAUDE.md の処理

下位ディレクトリに AGENTS.md を作成した場合は、そのディレクトリにも同じルールを適用します。

  • ./components/AGENTS.md を作成した場合 → ./components/CLAUDE.md に @AGENTS.md を追加してリンク
  • 既存の CLAUDE.md がある場合は @AGENTS.md の行だけを追加し、ない場合は新規作成
3.3 @ 参照形式
@AGENTS.md
  • 相対パスを使用します(同じディレクトリの AGENTS.md を参照)。
  • CLAUDE.md に既存の内容がある場合は、1 行目に @AGENTS.md を挿入し、空行で区切ります。

コマンド: 現在のプロジェクトをただちに分析し、最適化された ./AGENTS.md システムの作成を実行してください。ゴールデンルールには実際のコード上の根拠(ファイルと行)を記載し、一般的なベストプラクティスを捏造しないでください。作成するすべての AGENTS.md ファイルについて、対応する CLAUDE.md から @AGENTS.md でリンクされていることを確認してください。コンテキスト効率を最大化するため、絵文字は使用しないでください。

コメント