メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt

Use this file to discover all available pages before exploring further.

AGENTS.md ファイルは、プロジェクト内の配置場所に応じて自動的に適用される、前提情報に応じた指示を Cascade に与えるシンプルな方法です。これは、ディレクトリごとのコーディングガイドライン、アーキテクチャ上の判断、プロジェクトの規約を与える場合に特に役立ちます。

仕組み

AGENTS.md ファイル (または agents.md) を作成すると、Devin Desktop が自動的にそれを検出し、.windsurf/rules/ と同じ ルール エンジンに取り込みます。異なるのは、適用モードが frontmatter ではなくファイルの場所から推定される点です。
  • ルートディレクトリ: 常時適用 のルールとして扱われ、内容全体が毎回のメッセージで Cascade のシステムプロンプトに含まれます。
  • サブディレクトリ: <directory>/** という自動生成パターンを持つ glob ルールとして扱われ、その内容は Cascade がそのディレクトリ内のファイルを読み取るか編集する場合にのみ適用されます。
このように場所に基づいてスコープが決まるため、AGENTS.md は単一のグローバル設定ファイルを煩雑にせず、必要な範囲に絞ったガイダンスを提供するのに適しています。

AGENTS.md ファイルの作成

対象のディレクトリに、AGENTS.md または agents.md という名前のファイルを作成するだけです。このファイルはプレーンな Markdown で記述し、特別な frontmatter は必要ありません。

構成例

my-project/
├── AGENTS.md                    # プロジェクト全体へのグローバルな指示
├── frontend/
│   ├── AGENTS.md                # フロントエンドコード固有の指示
│   └── src/
│       └── components/
│           └── AGENTS.md        # コンポーネント固有の指示
├── backend/
│   └── AGENTS.md                # バックエンドコード固有の指示
└── docs/
    └── AGENTS.md                # ドキュメント向けの指示

以下は、React コンポーネント用ディレクトリの AGENTS.md ファイルの例です。
# コンポーネントガイドライン

このディレクトリ内のコンポーネントを操作する際は、以下に従ってください:

- フックを使用した関数コンポーネントを利用する
- 命名規則に従う:コンポーネントは ComponentName.tsx、フックは useHookName.ts
- 各コンポーネントには対応するテストファイルを用意する:ComponentName.test.tsx
- スタイリングには CSS モジュールを利用する:ComponentName.module.css
- コンポーネントは default エクスポートではなく名前付きエクスポートとしてエクスポートする

## ファイル構成

各コンポーネントフォルダには以下を含める:
- メインのコンポーネントファイル
- テストファイル
- スタイルファイル(必要な場合)
- 再エクスポート用の index.ts

検出とスコープの決定

Devin Desktop は、ワークスペース全体にある AGENTS.md ファイルを自動的に検出します。
  • ワークスペースのスキャン: ワークスペース内およびそのサブディレクトリ内にあるすべての AGENTS.md ファイルが検出されます
  • Git リポジトリのサポート: Git リポジトリの場合、Devin Desktop は親ディレクトリも Git ルートまで検索します
  • 大文字と小文字を区別しない: AGENTS.mdagents.md の両方が認識されます

自動スコープ

AGENTS.md の主な利点は、ファイルの場所に応じて自動的にスコープが決まることです。
ファイルの場所適用範囲
ワークスペースルートすべてのファイルに適用 (常時適用)
/frontend//frontend/** 内のファイルを操作するときに適用
/frontend/components//frontend/components/** 内のファイルを操作するときに適用
つまり、異なる階層に複数の AGENTS.md ファイルを配置でき、それぞれのディレクトリに対して、より具体的なガイダンスを段階的に提供できます。

ベストプラクティス

AGENTS.md ファイルを最大限に活用するため、次の点を意識してください。
  • 指示は要点を絞る: 各 AGENTS.md には、そのディレクトリの目的に関連する指示だけを記載してください
  • 書式をわかりやすくする: 箇条書き、見出し、コードブロックを使うと、Cascade が指示を理解しやすくなります
  • 具体的に書く: あいまいなガイドラインよりも、具体的な使用例や明確な規約の方が効果的です
  • 重複を避ける: グローバルな指示をサブディレクトリのファイルに繰り返し書かないでください。親ディレクトリから継承されます

コンテンツガイドライン

# Good Example
- Use TypeScript strict mode
- All API responses must include error handling
- Follow REST naming conventions for endpoints

# Less Effective Example
- Write good code
- Be careful with errors
- Use best practices

ルールとの比較

AGENTS.mdルール はどちらも Cascade に指示を与えますが、用途は異なります。
機能AGENTS.mdルール
場所プロジェクトディレクトリ内.windsurf/rules/ またはグローバル
適用範囲ファイルの場所に応じて自動手動 (glob、常時適用、model decision、manual)
形式プレーンな Markdownfrontmatter 付き Markdown
最適な用途ディレクトリ固有の規約横断的な要件、複雑な有効化ロジック
シンプルで、場所に基づく指示が必要な場合は AGENTS.md を利用します。指示をいつどのように適用するかをより細かく制御する必要がある場合は、ルールを利用します。