mcpField
A
agent-md-refactor

agent-md-refactor

github.com/softaworksエージェントワークフロー2.6k4.2k 回インストール34 週間前に更新
リポジトリ

agent-md-refactor について

agent-md-refactorは、段階的開示の原則に沿って、AGENTS.mdやCLAUDE.mdなどの長大なエージェント指示ファイルを整理します。共通の要点をルートに残し、他の指針を分類してリンクし、削除候補を示します。

主な機能

  1. 01指示の矛盾を検出
  2. 02ルートファイルの要点を抽出
  3. 03指針をカテゴリ別に整理
  4. 04リンク付きファイル階層を作成
  5. 05曖昧または冗長な内容を指摘

活用シーン

  1. 01長大なCLAUDE.mdの分割
  2. 02AGENTS.md指示の整理
  3. 03古い指針や冗長な内容の削除

インストール

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

$npx skills add https://github.com/softaworks/agent-toolkit --skill agent-md-refactor

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

同梱ファイルREADME.md

詳細

Agent MD Refactor

肥大化したエージェント指示ファイル(AGENTS.md、CLAUDE.md、COPILOT.md など)を、段階的開示(progressive disclosure)の原則に従ってリファクタリングします。必須事項はルートに残し、残りはリンクされたカテゴリ別ファイルに整理します。


トリガー

次の場合にこのスキルを使用します:

  • 「AGENTS.md をリファクタリングして」/「CLAUDE.md をリファクタリングして」
  • 「エージェント指示を分割して」
  • 「CLAUDE.md ファイルを整理して」
  • 「AGENTS.md が長すぎる」
  • 「指示に段階的開示を適用して」
  • 「エージェント設定をクリーンアップして」

クイックリファレンス

フェーズアクション出力
1. 分析矛盾を見つける解決すべき競合の一覧
2. 抽出必須事項を特定するルートファイル用のコア指示
3. 分類残りの指示をグループ化する論理的なカテゴリ
4. 構造化ファイル階層を作成するルート + リンクされたファイル
5. 整理削除対象をマークする冗長・曖昧な指示

プロセス

フェーズ 1: 矛盾を見つける

互いに矛盾する指示を特定します。

確認すべき点:

  • 相反するスタイルガイドライン(例: 「セミコロンを使う」対「セミコロンを使わない」)
  • 競合するワークフロー指示
  • 非互換なツールの設定
  • 相互排他的なパターン

見つかった矛盾ごとに:

## Contradiction Found

**Instruction A:** [quote]
**Instruction B:** [quote]

**Question:** Which should take precedence, or should both be conditional?

先に進む前に、ユーザーに解決してもらいます。


フェーズ 2: 必須事項を特定する

ルートのエージェントファイルに入れるべきものだけを抽出します。ルートは最小限にすべきです。対象はすべてのタスクに当てはまる情報です。

必須の内容(ルートに残す):

カテゴリ例
プロジェクトの説明1 文: 「分析用の React ダッシュボード」
パッケージマネージャーnpm 以外の場合のみ(例: 「pnpm を使用」)
標準外のコマンドカスタムのビルド/テスト/型チェックコマンド
重要なオーバーライドデフォルトを必ず上書きすべき事項
普遍的なルール全タスクの 100% に適用されるもの

必須ではない(リンクされたファイルに移す):

  • 言語固有の規約
  • テストに関するガイドライン
  • コードスタイルの詳細
  • フレームワークのパターン
  • ドキュメント作成の標準
  • Git ワークフローの詳細

フェーズ 3: 残りをグループ化する

残りの指示を論理的なカテゴリに整理します。

一般的なカテゴリ:

カテゴリ内容
typescript.mdTS の規約、型パターン、strict モードのルール
testing.mdテストフレームワーク、カバレッジ、モックパターン
code-style.mdフォーマット、命名、コメント、構造
git-workflow.mdコミット、ブランチ、PR、レビュー
architecture.mdパターン、フォルダー構成、依存関係
api-design.mdREST/GraphQL の規約、エラー処理
security.md認証パターン、入力検証、シークレット
performance.md最適化ルール、キャッシュ、遅延読み込み

グループ化のルール:

  1. 各ファイルは、そのトピックについて自己完結している必要があります
  2. ファイル数は 3〜8 を目安にします(細かすぎず、粗すぎず)
  3. ファイル名は明確に: {topic}.md
  4. 実行可能な指示のみを含めます

フェーズ 4: ファイル構造を作成する

出力構造:

project-root/
├── CLAUDE.md (or AGENTS.md)     # Minimal root with links
└── .claude/                      # Or docs/agent-instructions/
    ├── typescript.md
    ├── testing.md
    ├── code-style.md
    ├── git-workflow.md
    └── architecture.md

ルートファイルのテンプレート:

# Project Name

One-sentence description of the project.

## Quick Reference

- **Package Manager:** pnpm
- **Build:** `pnpm build`
- **Test:** `pnpm test`
- **Typecheck:** `pnpm typecheck`

## Detailed Instructions

For specific guidelines, see:
- [TypeScript Conventions](.claude/typescript.md)
- [Testing Guidelines](.claude/testing.md)
- [Code Style](.claude/code-style.md)
- [Git Workflow](.claude/git-workflow.md)
- [Architecture Patterns](.claude/architecture.md)

リンクされた各ファイルのテンプレート:

# {Topic} Guidelines

## Overview
Brief context for when these guidelines apply.

## Rules

### Rule Category 1
- Specific, actionable instruction
- Another specific instruction

### Rule Category 2
- Specific, actionable instruction

## Examples

### Good
\`\`\`typescript
// Example of correct pattern
\`\`\`

### Avoid
\`\`\`typescript
// Example of what not to do
\`\`\`

フェーズ 5: 削除対象をマークする

完全に削除すべき指示を特定します。

次の場合は削除:

基準例削除理由
冗長「TypeScript を使う」(.ts プロジェクト内)エージェントはすでに知っている
曖昧すぎる「きれいなコードを書く」実行可能ではない
明らかすぎる「バグを埋め込まない」コンテキストを無駄にする
デフォルトの動作「わかりやすい変数名を使う」標準的な慣行
古い非推奨の API を参照しているもはや当てはまらない

出力形式:

## Flagged for Deletion

| Instruction | Reason |
|-------------|--------|
| "Write clean, maintainable code" | Too vague to be actionable |
| "Use TypeScript" | Redundant - project is already TS |
| "Don't commit secrets" | Agent already knows this |
| "Follow best practices" | Meaningless without specifics |

実行チェックリスト

[ ] Phase 1: All contradictions identified and resolved
[ ] Phase 2: Root file contains ONLY essentials
[ ] Phase 3: All remaining instructions categorized
[ ] Phase 4: File structure created with proper links
[ ] Phase 5: Redundant/vague instructions removed
[ ] Verify: Each linked file is self-contained
[ ] Verify: Root file is under 50 lines
[ ] Verify: All links work correctly

アンチパターン

避けるべきこと理由代わりに
すべてをルートに置く肥大化し、保守が難しいリンクされたファイルに分割する
カテゴリが多すぎる断片化する関連するトピックを統合する
曖昧な指示トークンを浪費し、価値がない具体的に書くか、削除する
デフォルトの重複記述エージェントは既に知っている必要な場合にのみ上書きする
深いネスト移動しにくいリンクを使ったフラットな構造にする

例

変更前(肥大化したルート)
# CLAUDE.md

This is a React project.

## Code Style
- Use 2 spaces
- Use semicolons
- Prefer const over let
- Use arrow functions
... (200 more lines)

## Testing
- Use Jest
- Coverage > 80%
... (100 more lines)

## TypeScript
- Enable strict mode
... (150 more lines)
変更後(段階的開示)
# CLAUDE.md

React dashboard for real-time analytics visualization.

## Commands
- `pnpm dev` - Start development server
- `pnpm test` - Run tests with coverage
- `pnpm build` - Production build

## Guidelines
- [Code Style](.claude/code-style.md)
- [Testing](.claude/testing.md)
- [TypeScript](.claude/typescript.md)

検証

リファクタリング後は、次の点を確認してください。

  1. ルートファイルが最小限である - 50行未満で、普遍的な情報のみを含む
  2. リンクが機能する - 参照されているすべてのファイルが存在する
  3. 矛盾がない - 指示が一貫している
  4. 実行可能な内容である - すべての指示が具体的である
  5. 網羅性が保たれている - 指示が失われていない(削除対象としてフラグが立てられたものを除く)
  6. 各ファイルが自己完結している - リンクされた各ファイルが単独で理解できる

コメント