AGENTS.md ファイルを使用して Gemini をカスタマイズする

Android Studio の Gemini に、1 つ以上の AGENTS.md ファイルを使用して、従うべきカスタム指示を与えます。AGENTS.md ファイルは、コードベース内の他のファイルとともに配置されるため、バージョン管理システム(VCS)に簡単にチェックインして、プロジェクト固有の指示、コーディング スタイル ルール、その他のガイダンスをチーム全体で共有できます。

バックアップの手順:

  1. プロジェクトのファイル システムの任意の場所に AGENTS.md ファイルを作成します。クエリを送信すると、Gemini は現在のディレクトリとすべての親ディレクトリで AGENTS.md ファイルをスキャンします。詳細については、AGENTS.md ファイルの仕組みをご覧ください

  2. 指示を追加します。Markdown を使用して指示を記述します。読みやすくするために、さまざまなルールに見出しと箇条書きを使用することを検討してください。 指示の例をご覧ください

  3. ファイルを保存して VCS に commit し、チームと共有します。

AGENTS.md ファイルをコンテキストとして管理する

チャットパネルの [コンテキスト] ドロワーを使用して、特定のクエリのコンテキストとして AGENTS.md ファイルを適用または削除できます。[AGENTS.md ファイル] オプションには、現在のディレクトリとその親ディレクトリにあるすべての AGENTS.md ファイルが含まれます。

AGENTS.md ファイルをコンテキストとして管理する
図 1.AGENTS.md ファイルをコンテキストとして管理する。

指示の例

AGENTS.md ファイルを使用して、エージェントに指示を与えることができます。以下に例を示しますが、指定する指示はプロジェクトに固有のものにする必要があります。

  • 「メイン アクティビティは /path/to/MainActivity.kt です。」
  • 「画面間の移動をサポートするコードは path/to/navigation/UiNavigation.kt です。」
  • 「HTTP リクエストを処理するコードは <path> にあります。」
  • プロジェクト アーキテクチャ
    • 「すべてのビジネス ロジックを ViewModel に配置します。」
    • 「レイヤード アーキテクチャの使用など、公式のアーキテクチャに関する推奨事項に常に従ってください。単方向データフロー(UDF)、ViewModel、ライフサイクル対応 UI 状態コレクションなどの推奨事項を使用します。」
  • 推奨ライブラリ: 「ナビゲーションには <library name> ライブラリを使用します。」
  • 一般的な API サービスまたは内部用語のプレースホルダ名を定義する: 「プライマリ バックエンド サービスは 'PhotoSift-API' と呼ばれます。」
  • 会社のスタイルガイド: 「すべての新しい UI コンポーネントは Jetpack Compose でビルドする必要があります。XML ベースのレイアウトは推奨しません。」

AGENTS.md ファイルをモジュール化する

大きな AGENTS.md ファイルを、さまざまなコンテキストで再利用できる小さなファイルに分割できます。

  1. 一連の指示を分離して、style-guidance.md などの別の Markdown ファイルに保存します。

  2. AGENTS.md ファイルで、インポートするファイルのパスの前に @ 記号を付けて、小さな Markdown ファイルを参照します。次のパス形式がサポートされています。

    • 相対パス:
      • @./file.md - 同じディレクトリからインポートする
      • @../file.md - 親ディレクトリからインポートする
      • @./subdirectory/file.md - サブディレクトリからインポートする
    • 絶対パス: @/absolute/path/to/file.md

たとえば、次の AGENTS.md ファイルは、他の 2 つの指示ファイルを参照しています。

# My AGENTS.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

AGENTS.md ファイルの仕組み

Gemini は、現在のディレクトリと親ディレクトリで AGENTS.md ファイルを自動的にスキャンし、その内容をプリアンブルとしてすべてのプロンプトの先頭に追加します。クエリを送信するときにファイルが開いていない場合、プロジェクトのルートにある AGENTS.md ファイル(存在する場合)がデフォルトで含まれます。

AGENTS.md ファイルとルールの違いは何ですか?

ルールを使用すると、すべてのプロンプトに適用される指示と設定 を定義することもできます。ただし、ルールは IntelliJ ファイル /.idea/project.prompts.xml で定義されますが、AGENTS.md ファイルはソースコードの横に保存され、IDE に依存しません。主な目的の 1 つがチームと指示を共有することである場合は、AGENTS.md ファイルを使用することをおすすめします。

AGENTS.md ファイルとスキルの違いは何ですか?

スキルは、リクエストがスキルの説明と一致したときに呼び出されるオンデマンドの専門知識を表しますが、AGENTS.md のコンテンツはすべてのプロンプトの先頭に追加されます。特定のタスクにはスキルを使用し、エージェントの一般的な動作に影響を与えるには AGENTS.md ファイルを使用することをおすすめします。スキルの詳細については、Android スキルの概要をご覧ください。