mcpField
A
agents-md

agents-md

github.com/getsentryエージェントワークフロー1.1k7.1k 回インストール5 日前に更新
リポジトリ

agents-md について

簡潔で実行可能な AGENTS.md の作成を支援する、リポジトリ保守向けスキルです。コーディングエージェントがプロジェクトの規約を調べ、指示ファイルの範囲を決め、パスとコマンドを確認できるようにします。

主な機能

  1. 01マニフェスト、コマンド、文書、規約の確認
  2. 02ルートまたはサブツリーの指示範囲の選択
  3. 03簡潔な AGENTS.md ガイドの作成
  4. 04参照パスとコマンドの検証
  5. 05必要に応じた CLAUDE.md のリンク

活用シーン

  1. 01コーディングエージェント向けリポジトリガイドの整備
  2. 02リポジトリとサブツリーの指示の切り分け
  3. 03Claude 互換の指示ファイルの同期

インストール

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

$npx skills add https://github.com/getsentry/skills --skill agents-md

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

同梱ファイルSOURCES.mdSPEC.md

詳細

AGENTS.md の保守

目標：簡潔で実行可能なエージェント向け指示にします。60 行未満を目指し、100 行を超えないようにしてください。

ワークフロー

  1. 書き始める前に調査します：
    • パッケージマネージャー：ロックファイルとマニフェスト
    • コマンド：package.json、Makefile、タスクランナー、CI ワークフロー
    • ドキュメント／仕様／ポリシー：README.md、CONTRIBUTING.md、docs/、specs/、policies/、SECURITY.md、.github/
    • 規約：現在のコードパターン、テストの配置、生成ファイル、避けるべきレガシー領域
  2. 対象範囲を決めます：
    • ルートの AGENTS.md：リポジトリ全体の既定ルール
    • ネストされた AGENTS.md：サブツリーに異なるコマンドやルールがある場合のみ
    • 最も近い指示ファイルが優先されます。範囲の狭いファイルはルートのファイルより短くしてください
  3. 有用な範囲で最小のファイルを作成します。
  4. パスとコマンドが実際に存在することを確認します。

ファイルの設定

  • リポジトリのルートに AGENTS.md を作成します。
  • Claude 互換のエントリーポイントが必要な場合は、CLAUDE.md から AGENTS.md へのシンボリックリンクを作成します。
  • 内容の異なる AGENTS.md と CLAUDE.md のコピーを別々に管理しないでください。

既定のセクション

明白でない価値を加えるセクションだけを使用します。

# Agent Instructions

## Package Manager
- Use **pnpm**: `pnpm install`

## Commands
| Task | Command |
|------|---------|
| Test file | `pnpm vitest run path/to/file.test.ts` |
| Lint file | `pnpm eslint path/to/file.ts` |

## External References
| Need | File |
|------|------|
| Setup | `CONTRIBUTING.md` |
| Architecture | `docs/architecture.md` |
| Security policy | `SECURITY.md` |

## Key Conventions
- Generated files: update with `pnpm generate`; do not edit by hand.

## Commit Attribution
AI commits MUST include:
```
Co-Authored-By: (the agent's name and attribution byline)
```

執筆ルール

  • 見出し、箇条書き、表を使い、段落は避けます。
  • リポジトリ相対パスを使い、「ドキュメントを参照」のような曖昧な表現は避けます。
  • 既存のドキュメント／仕様／ポリシーを参照し、内容を複製しないでください。
  • セットアップ、アーキテクチャ、API 仕様、セキュリティ、リリース、ポリシーのドキュメントが存在する場合は、該当する外部ファイルを正確に列挙します。
  • ファイル単位で実行できるテスト／リンター／型チェックのコマンドを優先し、より限定的なコマンドがない場合にのみ全体ビルドを含めます。
  • コマンドが複数ある場合は表に記載します。
  • 箇条書き 1 つにつきルールは 1 つにします。
  • ありがちな間違いを防ぐ場合を除き、理由は記載しません。
  • リンター、フォーマッター、型チェッカーの設定を言い換えて記載しないでください。
  • インストール済みのスキルやプラグインを列挙しないでください。
  • 汎用的な品質スローガンを含めないでください。

外部参照のルール

適切な例：

## External References
| Need | File |
|------|------|
| API contract | `docs/api.md` |
| Release process | `docs/releasing.md` |

アンチパターン

  • 歓迎の文、導入、結論、挨拶
  • 指示が重要な理由を説明する長い文章
  • README.md、CONTRIBUTING.md、ポリシードキュメントの内容の重複
  • ファイル単位で実行できるコマンドがある場合の、プロジェクト全体を対象とするコマンド
  • ルートの指示を繰り返すネストされた AGENTS.md ファイル

コメント

Markdown 対応