agent-friendly-guide は何をしますか？
コードベースをエージェントフレンドリーにするための実践的な手法（+ Claude Codeスキル）です。
はじめに
AIエージェント（Claude Code、Cursor、Codexなど）は、コードベースを読み取り、理解し、操作することで開発を支援します。しかし、複雑で整理されていないコードベースでは、エージェントの効果が低下します。このガイドは、コードベースをエージェントフレンドリーにするための具体的な手法を提供します。
主要な原則
- 明確なドキュメント: README、CONTRIBUTING.md、API仕様書などを整備する。
- 一貫した命名規則: 変数名、関数名、クラス名に意味のある名前を使用する。
- 適切なコメント: コードの意図や複雑なロジックを説明するコメントを追加する。
- モジュール化: 関心の分離を徹底し、各モジュールの責務を明確にする。
- テストの充実: ユニットテストや統合テストを整備し、エージェントが動作を確認できるようにする。
Claude Codeスキルとしての利用
このスキルはClaude Codeと組み合わせて使用できます。スキルを有効にすると、Claude Codeは自動的にコードベースのエージェントフレンドリー度を評価し、改善提案を行います。
インストール
claude code install-skill mixcode/agent-friendly-guide
使い方
- Claude Codeを起動します。
- プロンプトで「コードベースをエージェントフレンドリーにする」と指示します。
- Claude Codeが自動的にコードベースを分析し、改善点をリストアップします。
- 提案された変更を適用するかどうかを選択します。
ベストプラクティス
- コードベースのルートに
AGENTS.mdファイルを配置し、エージェント向けの注意事項を記載する。 - 環境変数や設定は
.env.exampleなどで明確に定義する。 - ビルドスクリプトやデプロイ手順は
Makefileやscripts/ディレクトリにまとめる。 - コード内のTODOコメントはエージェントが認識できる形式（
TODO(@agent): ...）で記述する。
関連リソース
ライセンス
MIT