mcpField
A
agents-md-generator

agents-md-generator

github.com/julianromliエージェントワークフロー21382 回インストール6 日前に更新
リポジトリ

agents-md-generator について

agents-md-generatorは、AIコーディングエージェント向けに階層型のAGENTS.mdを作成するスキルです。リポジトリを分析してから、簡潔なルートファイルと詳細なサブフォルダ用ファイルを生成し、実行可能でトークン効率のよい指針を重視します。

主な機能

  1. 01リポジトリ構成と技術スタックの分析
  2. 02簡潔なルートAGENTS.mdの生成
  3. 03詳細なサブフォルダ用ガイドの生成
  4. 04一般的なパッケージ向けテンプレート
  5. 05ガイドの構成と具体性の確認

活用シーン

  1. 01ガイド作成前のリポジトリ整理
  2. 02コーディングエージェント向けルート指示の作成
  3. 03パッケージ別の開発指針の追加
  4. 04AGENTS.mdの構成と具体性の確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/julianromli/ai-skills --skill agents-md-generator

インストール後、Claude Code で/agents-md-generatorを入力して読み込まれたか確認します。

詳細

AGENTS.md ジェネレーター

AI コーディングエージェント向けに、トークン使用量を最小限に抑えた階層的な AGENTS.md 構成を生成します。

基本原則

  1. ルートの AGENTS.md は簡潔に — 全体に適用されるガイダンスとサブファイルへのリンクのみを記載します（最大約 100～200 行）。
  2. 最も近いファイルを優先 — エージェントは編集対象のファイルに最も近い AGENTS.md を読みます。
  3. JIT インデックス — 全文ではなく、パス、glob、コマンドを提示します。
  4. トークン効率 — 百科事典のようなドキュメントより、小さく実行可能なガイダンスを優先します。
  5. サブフォルダーのファイルには詳細を記載 — 具体的なパターン、例、コマンドを含めます。

ワークフロー

フェーズ 1：リポジトリの分析

次の項目を分析して報告します。

  1. リポジトリの種類：モノレポ、マルチパッケージ、またはシンプルな構成ですか？
  2. 技術スタック：言語、フレームワーク、主要なツール
  3. 独自の AGENTS.md が必要な主なディレクトリ：
    • アプリ（apps/web、apps/api、apps/mobile）
    • サービス（services/auth、services/transcribe）
    • パッケージ（packages/ui、packages/shared）
    • ワーカー（workers/queue、workers/cron）
  4. ビルドシステム：pnpm/npm/yarn ワークスペースですか？Turborepo ですか？Lerna ですか？
  5. テスト環境：Jest、Vitest、Playwright、pytest のいずれですか？
  6. 主なパターン：構成、規約、例、アンチパターン

ファイルを生成する前に、構造化されたマップとして提示します。

フェーズ 2：ルートの AGENTS.md

簡潔なルートファイルを作成します（約 100～200 行）。

# Project Name

## Project Snapshot
[3-5 lines: repo type, tech stack, note about sub-AGENTS.md files]

## Root Setup Commands
[5-10 lines: install, build all, typecheck all, test all]

## Universal Conventions
[5-10 lines: code style, commit format, branch strategy, PR requirements]

## Security & Secrets
[3-5 lines: never commit tokens, .env patterns, PII handling]

## JIT Index
### Package Structure
- Web UI: `apps/web/` -> [see apps/web/AGENTS.md](apps/web/AGENTS.md)
- API: `apps/api/` -> [see apps/api/AGENTS.md](apps/api/AGENTS.md)

### Quick Find Commands
- Search function: `rg -n "functionName" apps/** packages/**`
- Find component: `rg -n "export.*ComponentName" apps/web/src`
- Find API routes: `rg -n "export const (GET|POST)" apps/api`

## Definition of Done
[3-5 lines: what must pass before PR]
フェーズ 3：サブフォルダーの AGENTS.md

主な各パッケージについて、詳細な AGENTS.md を作成します。

# Package Name

## Package Identity
[2-3 lines: what it does, primary tech]

## Setup & Run
[5-10 lines: install, dev, build, test, lint commands]

## Patterns & Conventions
[10-20 lines - MOST IMPORTANT SECTION]
- File organization rules
- Naming conventions
- Examples with actual file paths:
  - DO: Use pattern from `src/components/Button.tsx`
  - DON'T: Class components like `src/legacy/OldButton.tsx`
  - Forms: Copy `src/components/forms/ContactForm.tsx`
  - API calls: See `src/hooks/useUser.ts`

## Key Files
[5-10 lines: important files to understand package]
- Auth: `src/auth/provider.tsx`
- API client: `src/lib/api.ts`
- Types: `src/types/index.ts`

## JIT Index Hints
[5-10 lines: search commands for this package]
- Find component: `rg -n "export function .*" src/components`
- Find hook: `rg -n "export const use" src/hooks`
- Find tests: `find . -name "*.test.ts"`

## Common Gotchas
[3-5 lines if applicable]
- "Auth requires NEXT_PUBLIC_ prefix for client-side"
- "Always use @/ imports for absolute paths"

## Pre-PR Checks
[2-3 lines: copy-paste command]
pnpm --filter @repo/web typecheck && pnpm --filter @repo/web test
フェーズ 4：特別なテンプレート
デザインシステム／UI パッケージ
## Design System
- Components: `packages/ui/src/components/**`
- Use design tokens from `packages/ui/src/tokens.ts`
- Component gallery: `pnpm --filter @repo/ui storybook`
- Examples:
  - Buttons: `packages/ui/src/components/Button/Button.tsx`
  - Forms: `packages/ui/src/components/Input/Input.tsx`
データベース／データレイヤー
## Database
- ORM: Prisma / Drizzle / TypeORM
- Schema: `prisma/schema.prisma`
- Migrations: `pnpm db:migrate`
- Connection: via `src/lib/db.ts` singleton
- NEVER run migrations in tests
API／バックエンドサービス
## API Patterns
- REST routes: `src/routes/**/*.ts`
- Auth middleware: `src/middleware/auth.ts`
- Validation: Zod schemas in `src/schemas/**`
- Errors: `ApiError` from `src/lib/errors.ts`
- Example: `src/routes/users/get.ts`
テスト
## Testing
- Unit: `*.test.ts` colocated
- Integration: `tests/integration/**`
- E2E: `tests/e2e/**` (Playwright)
- Single test: `pnpm test -- path/to/file.test.ts`
- Mocks: `src/test/mocks/**`

出力形式

次の順番でファイルを提示します。

  1. 分析の概要
  2. ルートの AGENTS.md（全体）
  3. 各サブフォルダーの AGENTS.md（ファイルパスを記載）

形式：

---
File: `AGENTS.md` (root)
---
[content]

---
File: `apps/web/AGENTS.md`
---
[content]

品質チェックリスト

生成する前に、以下を確認します。

  • ルートの AGENTS.md が 200 行未満である
  • ルートからすべてのサブ AGENTS.md へのリンクがある
  • 各サブファイルに具体例（実際のパス）がある
  • コマンドがコピーしてすぐに実行できる
  • ルートとサブファイルの間に重複がない
  • JIT のヒントに実際のパターン（ripgrep、find、glob）を使っている
  • すべての「DO」に実際のファイル例がある
  • すべての「DON'T」で実際のアンチパターンを参照している
  • PR 前のチェックが単一のコマンドで実行できる

コメント

Markdown 対応