tomevault-io AGENTS.md クリエイター
このスキルは、AI コーディングエージェント向けの指示書「AGENTS.md」の作成をサポートします。
AGENTS.md について
AGENTS.md は、AI エージェント専用の「エージェント用 README」として機能するファイルです。人間向けの README.md とは別に、AI がプロジェクトを理解し、適切にコードを書いたりテストしたりするために必要な文脈と指示を集約します。
特徴
- オープンな標準フォーマット: 特定のツールに依存せず、複数の AI エージェントで共通利用可能
- 階層構造対応: モノレポではサブディレクトリごとに配置でき、最も近いファイルが優先される
- 自動実行: 記載されたテストコマンドをエージェントが自動実行可能
作成ワークフロー
1. プロジェクト情報の収集
AGENTS.md を作成する前に、以下の情報を収集：
- プロジェクト概要: プロジェクトの目的や全体像
- 技術スタック: 使用言語、フレームワーク、主要ライブラリ
- 既存のドキュメント: README.md、package.json、設定ファイルなどを確認
2. セクション構成の決定
プロジェクトの性質に応じて、以下から必要なセクションを選択：
| セクション | 説明 | 優先度 |
|---|---|---|
| プロジェクト概要 | 目的と全体像 | 高 |
| セットアップ・ビルドコマンド | 依存関係のインストール、開発サーバー起動 | 高 |
| テスト手順 | テスト実行方法、フォーカス方法 | 高 |
| コードスタイル・規約 | 言語設定、フォーマット規則、関数パターン | 中 |
| PR・コミット規定 | PR タイトル形式、コミット前チェック | 中 |
| 環境固有のチップス | ディレクトリ構造、パッケージ管理のコツ | 低 |
| セキュリティ上の注意 | セキュリティ考慮事項 | 必要時 |
3. AGENTS.md の作成
基本構造
# AGENTS.md
## プロジェクト概要
[プロジェクトの目的と全体像を簡潔に記述]
## セットアップ
[依存関係のインストール方法]
[開発サーバーの起動方法]
## ビルド
[ビルドコマンドと手順]
## テスト
[テストの実行方法]
[特定のテストへのフォーカス方法]
## コードスタイル
[使用する言語設定]
[フォーマット規則]
[命名規則]
## PR・コミット規定
[PR タイトルの形式]
[コミット前に行うべきチェック]
## ディレクトリ構造
[重要なディレクトリの説明]
## 注意事項
[セキュリティ上の注意]
[その他の重要な考慮事項]
4. 保存先の決定
- 単一プロジェクト: リポジトリルートに
AGENTS.mdを配置 - モノレポ: サブディレクトリごとに配置可能（AI は最も近いファイルを優先）
執筆ガイドライン
記述のポイント
具体的なコマンドを記載: AI が直接実行できる形式で
✓ pnpm install && pnpm dev ✗ 依存関係をインストールしてください新しいチームメイトに伝えるべきこと: 暗黙知を明文化する
- 「README には書いていないけど、このプロジェクトでは...」
- 「テスト前には必ず...」
人間用ドキュメントとの分離: ビルド手順の詳細など、人間には冗長な情報は AGENTS.md へ
避けるべきこと
- 一般的な知識の繰り返し（AI が既に知っていること）
- 曖昧な指示（「適切に対応」ではなく具体的に）
- 古い情報の放置（定期的に更新を推奨）
プロジェクトタイプ別テンプレート
Node.js/TypeScript プロジェクト
# AGENTS.md
## プロジェクト概要
[プロジェクトの説明]
## セットアップ
pnpm install
## 開発サーバー
pnpm dev
## ビルド
pnpm build
## テスト
pnpm test
# 特定のテストを実行
pnpm test -- --grep "test name"
## コードスタイル
- TypeScript strict mode 使用
- セミコロンなし
- シングルクォート使用
- インデント: 2 スペース
## リント
pnpm lint
pnpm lint:fix
## PR 規定
- タイトル形式: `[type]: description`
- コミット前に `pnpm lint && pnpm test` を実行
Python プロジェクト
# AGENTS.md
## プロジェクト概要
[プロジェクトの説明]
## セットアップ
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
## テスト
pytest
# 特定のテストを実行
pytest tests/test_module.py -k "test_name"
## コードスタイル
- Python 3.10+
- Black でフォーマット
- isort でインポート整理
- mypy で型チェック
## リント
black .
isort .
mypy src/
## PR 規定
- コミット前に `black . && isort . && pytest` を実行
Go プロジェクト
# AGENTS.md
## プロジェクト概要
[プロジェクトの説明]
## セットアップ
go mod download
## ビルド
go build ./...
## テスト
go test ./...
# 特定のテストを実行
go test ./... -run TestName
## コードスタイル
- gofmt でフォーマット
- golint でリント
- Go 1.21+
## リント
go fmt ./...
golint ./...
go vet ./...
インタラクティブな作成プロセス
すべての情報が最初から提供されていない場合は、ユーザーに質問して情報を収集します。
推奨される質問順序
- 「このプロジェクトはどのような技術スタック（言語、フレームワーク）を使用していますか？」
- 「ビルドやテストにはどのようなコマンドを使用しますか？」
- 「コーディング規約やスタイルガイドはありますか？」
- 「PR やコミットに関する規定はありますか？」
- 「AI エージェントが作業する際に知っておくべき特別な注意点はありますか？」
一度に多くの質問をせず、最も重要な情報から段階的に収集してください。
Source: ks6088ts-labs/skills — distributed by TomeVault.