ドキュメント

エージェントおよびCoroid用のAGENTS.mdを作成する

開発者アシスタントとCoroidのエージェント向けの指示ファイルです。両者が共通で利用する内容、Coroid自身が実行する処理、および品質基準を維持する方法が記載されています。

Claude CodeやCodex、Cursorといった開発者アシスタント、およびCoroidのエージェントは、同じAGENTS.md。そのほとんどは両者に共通して適用されます:コマンド、規約、制約事項などです。例外となるのはGitワークフローで、これはCoroidがブランチ、コミット、プルリクエストを自動で作成します。

Coroidのエージェントが読み取る内容

各タスクの実行前に、Coroidのエージェントはリポジトリのルートディレクトリにあるメモリファイルを読み取ります:AGENTS.md、CLAUDE.md、GEMINI.mdおよびCursorのルールも.cursor/rules。これらに従います@インポート処理を行い、同一の指示内容は一度だけ含まれます。エージェントが受け取るソースを選択するには 設定 → ナレッジ → コンテキスト設定 → ナレッジ → コンテキスト。詳細はプロジェクトコンテキスト。

タスクは自身のチェックアウト先からファイルを読み取ります。そのため、AGENTS.mdへの変更は、ベースブランチにマージされた後に開始されるタスクにのみ適用されます。

両者に共通して適用される内容

これらはすべてのエージェント向けに一度だけ記述します:

  • コマンド:install、build、test、および最も狭い範囲のテスト(例:1つのパッケージや1つのファイル)。これらはクリーンなクローン環境で確認し、実行用のディレクトリ名やテストに必要なサービスを明記します。
  • コード上では明示されない規約:命名規則、エラーハンドリング、文字列の翻訳方法、禁止されるパターンなど。
  • 制約事項:固定されたモジュール、チームが管理するパス、追加を許可しない依存関係、手動での編集を禁止するファイルなど。

簡潔にまとめてください。各行はすべてのタスクで、すべてのエージェントによって読み取られます。長文は別のドキュメントへリンクし、コード上で既に記述されている内容は省略します。

Coroid自身が実行する処理

Coroidのエージェントはサンドボックス内でファイルを変更します。残りの処理はCoroidが行います:

ステップCoroid内での処理
ブランチCoroidは各タスクごとに1つブランチを作成します:feature/coroid-<id>-<title>、またはbugfix/、refactor/、test/、あるいはdocs/作業の種類に応じて分けられます。プランのレーンではcoroid/factory/…
コミットCoroidはコミットメッセージを作成し、来歴を示すトレーラーとしてCoroid-Taskを追加します。接続されたアカウントが作成者である場合はCo-authored-by: Coroid <ai@coroid.ai>
プッシュCoroidはブランチをプッシュします。サンドボックスはgit push、git pull、git fetchおよびgit clone、プロバイダー用の認証情報は保持しません。
プルリクエストCoroidはタスク名をタイトルとし、タスク、受入基準、QA結果、レビュー結果へのリンクを記載した説明付きでプルリクエストを開きます。

「...に取り組む」といった指示ws/ブランチ」、「pull requestを開くgh pr create「コミットの末尾に共同著者行を追加する」といった指示もCoroid内では無効です。エージェントが変更したファイルのみがサンドボックスから出され、そこで作成されたブランチやコミットは破棄されます。Coroidは指示ファイルを読み込む前にエージェントにこの点を伝え、それらのステップをスキップさせて残りの指示に従わせます。

ベースブランチにコミットされるものは一切ありません:詳細はリポジトリおよびブランチの設定。

適用範囲を明確に指定してください

Coroidのエージェントは既にGitワークフローをスキップしています。ファイル内でこれを明記することで、読者全員にとって分かりやすく、Coroid専用のステップ(例:完了前に実行するチェック)を一箇所にまとめられます。冒頭近くに短いセクションを設けて記述します:

## Working in Coroid

When you run inside Coroid, Coroid creates the branch, commits, pushes and
opens the pull request. Change files only, and skip "Git workflow" below.
Before you finish, run `npm run validate`.

次に、ローカルワークフローをその本来の用途に合わせてマークします:

## Git workflow (local agents)

- Branch: `ws/<nn>-<name>` from `main`, in your own worktree.
- Commit messages end with your assistant's co-author line.
- Run `npm run check:local`, then open the pull request with `gh pr create`.

開発者アシスタントは各自のワークフローを維持し、どのステップが誰のものかを推測する必要がなくなります。

pull requestが必ず通過しなければならないチェック項目

「AGENTS.mdにのみ記述されたチェックは、エージェントが実行を決定した際に実施されます。CoroidのコミットはHuskyやpre-commitといったリポジトリのGitフックもスキップします。すべての変更に適用されるべきチェックは品質管理としてリポジトリコマンドチェック:

  • Coroidはエージェントが行った変更に対してこのチェックを実行します。
  • pull requestのチェック機能が有効な場合、Claude Code、Codex、Cursorで作成されたプルリクエストにも適用されます。

こうして2つのワークフローが同じ基準を満たします。詳細は品質ポリシーとゲート。

不要なコードを排除するルールについては、開発者アシスタントがMCP経由でCoroidに問い合わせることができます。anti_slop_rulesはプロジェクトのルールを記載したスニペットを返します。AGENTS.md:詳細はエディタからの不要コード排除ルール。

一部のブランチでのみ実行されるCI

CIやブランチ保護が特定のブランチ名でのみ実行される場合は、Coroidのブランチ名も追加してください:

feature/coroid-*
bugfix/coroid-*
refactor/coroid-*
test/coroid-*
docs/coroid-*
coroid/factory/**

そうしないと、Coroidが開くプルリクエストにチームが依存するチェックが適用されません。

各ツール向けのファイルを1つにまとめる

指示内容は一度だけ、AGENTS.md:

  • CodexおよびCursor読むAGENTS.md。
  • Claude Code読み込むCLAUDE.md。それを1行にまとめて、 Claude Codeが必要とする内容だけを含めます。@AGENTS.mdCursorも同様にそのルールを読み込みます。
  • Cursorもそのルールを読み込みます。.cursor/rules。Coroidはそれらを読み込み、 Cursorが適用するようになります。詳細はこちらをご覧ください:プロジェクトコンテキスト。

CoroidはCLAUDE.mdをインポートし、それを含めます。AGENTS.md一度だけ。

Coroidが何を読み込んでいるかを確認してください

「設定 → ナレッジ → コンテキスト、リポジトリソース各ファイルを一覧表示し、 推定トークン数と切り替えスイッチを示します。編集そこでファイルを開きます。保存すると、 接続されたリポジトリ上にpull requestが作成され、他の変更と同様にレビューが行われます。