AGENTS.mdカスタマイズファイル

GitLab Duoは、AIコーディングアシスタントにコンテキストや指示を提供するための新たな標準であるAGENTS.md仕様をサポートしています。

AGENTS.mdファイルを使用して、リポジトリ構造、コーディング規約、スタイルガイドライン、ビルドおよびテストの手順、プロジェクトのコンテキストを文書化します。AGENTS.mdファイルを指定すると、これらの詳細は、この仕様をサポートするGitLab Duoやその他のAIツールで使用できるようになります。

GitLab Duoで使用するAGENTS.mdファイルは、次を対象に指定します:

• IDEのGitLab Duo Chat。
• 基本フローおよびカスタムフロー。

GitLab DuoでAGENTS.mdファイルを使用する方法

AGENTS.mdファイルは、複数のレベルで作成できます:

• ユーザーレベル: すべてのプロジェクトとワークスペースに適用されます。
• ワークスペースレベル: 特定のプロジェクトまたはワークスペースにのみ適用されます。
• サブディレクトリレベル: モノレポ内の特定のプロジェクトのディレクトリ、または特定のコンポーネントを含むプロジェクト内のディレクトリにのみ適用します。

GitLab Duo Chatは、ユーザーレベルおよびワークスペースレベルのAGENTS.mdファイルに含まれる指示を、すべての会話に適用します。タスクの実行にあたって、追加のAGENTS.mdファイルを含むディレクトリ内のファイルを操作する必要がある場合、そのファイルに記載された指示も適用します。

GitLab DuoでAGENTS.mdを使用する

前提条件

• IDEのGitLab Duo Chatの場合、サポートされている拡張機能をインストールします:

  • VS Codeの場合は、6.60以降のVS Code用GitLab Workflow拡張機能をインストールして設定します。
  • JetBrains IDEの場合は、3.26.0以降のJetBrains用GitLabプラグインをインストールして設定します。

• カスタムルールの場合は、executorから渡されるuser_ruleコンテキストにアクセスできるよう、フローの設定ファイルを更新します:

  components:
  - name: "my_agent"
     type: AgentComponent
     prompt_id: "my_prompt"
     inputs:
     - from: "context:inputs.user_rule"
        as: "agents_dot_md"
      optional: true

  optional: trueを設定することにより、AGENTS.mdファイルが存在しない場合でもフローは正常に処理されます。エージェントは、追加のコンテキストの有無にかかわらず動作します。

ユーザーレベルのAGENTS.mdファイルを作成する

ユーザーレベルのAGENTS.mdファイルは、すべてのプロジェクトとワークスペースに適用されます。

1. ユーザー設定ディレクトリにAGENTS.mdファイルを作成します:

   • Linux/macOSでは、ホームディレクトリに~/.gitlab/duo/AGENTS.mdファイルを作成するか、Windowsでは%APPDATA%\GitLab\duo\AGENTS.mdファイルを作成します。
   • GLAB_CONFIG_DIR環境変数を設定している場合は、次の場所にファイルを作成します: $GLAB_CONFIG_DIR/AGENTS.md
   • XDG_CONFIG_HOME環境変数を使用している場合は、次の場所にファイルを作成します: $XDG_CONFIG_HOME/gitlab/duo/AGENTS.md

2. ファイルに指示を追加します。例:

   個人の設定

   # My personal coding preferences
   
   - Always explain code changes in simple terms for beginners
   - Use descriptive variable names
   - Add comments for complex logic
   - Prefer functional programming patterns when appropriate

   チーム標準

   # Team coding standards
   
   - Follow our company's style guide for all code
   - Use TypeScript strict mode
   - Write unit tests for all new functions
   - Document all public APIs with JSDoc

   モノレポコンテキスト

   # Monorepo context
   
   - This is a monorepo with multiple services
   - Frontend code is in /apps/web
   - Backend services are in /services
   - Shared libraries are in /packages
   - Follow the architecture decision records in /docs/adr

   セキュリティガイドライン

   # Security review guidelines
   
   - Always validate user input
   - Use parameterized queries for database operations
   - Implement proper authentication and authorization
   - Follow OWASP security best practices
   - Never log sensitive information

3. ファイルを保存します。

4. 指示を適用するには、新しい会話またはフローを開始します。AGENTS.mdファイルを変更するたびに、これを行う必要があります。

ワークスペースレベルのAGENTS.mdファイルを作成する

ワークスペースレベルのAGENTS.mdファイルは、特定のプロジェクトまたはワークスペースにのみ適用されます。

1. プロジェクトのワークスペースのルートで、AGENTS.mdファイルを作成します。

2. ファイルに指示を追加します。例:

   # Project-specific guidelines
   
   - This project uses React with TypeScript
   - Follow the component structure in /src/components
   - Use our custom hooks from /src/hooks
   - State management uses Redux Toolkit

3. ファイルを保存します。

4. 指示を適用するには、新しい会話またはフローを開始します。AGENTS.mdファイルを変更するたびに、これを行う必要があります。

モノレポおよびサブディレクトリにAGENTS.mdファイルを作成する

モノレポまたは特定のコンポーネントを含むプロジェクトでは、サブディレクトリにAGENTS.mdファイルを配置することで、コードベースのさまざまな部分に応じたコンテキスト固有の指示を提供できます。

GitLab Duo Chatが、サブディレクトリにある追加のAGENTS.mdファイルを検出すると、そのディレクトリ内のファイルを編集する前に、関連ファイルを読み取ります。例:

/my-project
  AGENTS.md              # Root instructions (included in all conversations)
  /frontend
    AGENTS.md            # Frontend-specific instructions
  /backend
    AGENTS.md            # Backend-specific instructions

この例では:

• ルートのAGENTS.mdは、常に会話に含まれます。
• GitLab Duoが/frontend内のファイルを編集する際、最初に/frontend/AGENTS.mdを読み取ります。
• GitLab Duoが/backend内のファイルを編集する際、最初に/backend/AGENTS.mdを読み取ります。

このアプローチにより、GitLab Duoはプロジェクトの各部分に適した規則に従うようになります。

サブディレクトリでAGENTS.mdを使用するには:

1. プロジェクトのサブディレクトリにAGENTS.mdファイルを作成します。

2. そのディレクトリに固有の指示を追加します。たとえば、バックエンドサービスの場合は次のようになります:

   # Backend service guidelines
   
   - This service uses Node.js with Express
   - Follow RESTful API conventions
   - Use async/await for asynchronous operations
   - Validate all inputs with Joi schemas

3. ファイルを保存します。

4. 指示を適用するには、そのディレクトリ内のファイルが関係する新しい会話を開始します。AGENTS.mdファイルを変更するたびに、これを行う必要があります。

関連トピック

• カスタムルール