Shared Knowledge MCP Server

--- description: AIコードエージェントの基本ガイドラインと利用規約 ruleId: guidelines-01jpcvxfxs0zr4jqmx1jn4f9rf tags: - ai - guidelines - best-practices aliases: - ai-guidelines globs: - '**/*.ts' - '**/*.js' - '**/*.py' - '**/*.go' - '**/*.rs' - '**/*.scala' - '**/*.java' --- # AIコードエージェントガイドライン ## 概要 このドキュメントは、AIコードエージェントの利用に関する基本的なガイドラインと規約を定義します。 開発者とAIエージェントの効果的な協働を実現するための指針を提供します。 ## 基本原則 ### 1. 明確なコミュニケーション - 具体的で明確な指示を提供する。 - 目的と期待する結果を明確に説明する。 - 制約条件や要件を明示的に伝える。 - 必要な文脈情報を提供する。 ### 2. イテレーティブな開発 - 大きなタスクは小さな単位に分割する。 - 段階的な実装とフィードバックを繰り返す。 - 各ステップでの成果物を確認する。 - 必要に応じて方向性を調整する。 ### 3. 品質管理 - AIが生成したコードを必ずレビューする。 - テストケースの作成と実行を依頼する。 - エッジケースの考慮を明示的に要求する。 - パフォーマンスと保守性を考慮する。 ### 4. セキュリティ考慮事項 - 機密情報の取り扱いに注意する。 - セキュリティベストプラクティスの遵守を要求する。 - 生成されたコードのセキュリティレビューする。 - 依存関係の脆弱性チェックを実施する。 ## 効果的な利用方法 ### 1. タスク定義 - 目的と要件を明確に定義する。 - 受け入れ基準を明示する。 - 技術的な制約を説明する。 - 優先順位を設定する。 ### 2. コード生成 - 既存のコードベースとの整合性を確認する。 - コーディング規約の遵守を要求する。 - 適切なエラー処理の実装を依頼する。 - ドキュメント生成を含める。 ### 3. レビューとフィードバック - 生成されたコードを詳細にレビューする。 - 具体的なフィードバックを提供する。 - 改善点を明確に説明する。 - 良い実装を評価する。 ### 4. 反復と改善 - フィードバックに基づく修正を依頼する。 - 段階的な改善を進める。 - 学習した内容を記録する。 - ベストプラクティスを更新する。 ## 制限事項 ### 1. 技術的制限 - AIの知識カットオフ日に注意する。 - 特定の技術スタックの制限を理解する。 - 複雑な文脈の理解には限界がある。 - 生成コードの品質にばらつきがある可能性。 ### 2. 運用上の制限 - 同時実行の制限に注意する。 - レスポンス時間の変動を考慮する。 - トークン制限を意識する。 - API制限を把握する。 ## ベストプラクティス ### 1. プロジェクト固有の設定 - プロジェクトのコーディング規約を共有する。 - 技術スタックの詳細を説明する。 - アーキテクチャの制約を伝える。 - 既存のパターンを示す。 ### 2. 効率的な対話 - 明確で簡潔な指示を心がける。 - 必要な文脈情報を適切に提供する。 - フィードバックは具体的に行う。 - 成功事例を共有する。 ### 3. 品質管理 - 自動テストの作成を依頼する。 - コードレビューのチェックリストを用意する。 - パフォーマンス要件を明確にする。 - セキュリティガイドラインを遵守する。 ## トラブルシューティング ### 1. 一般的な問題 - 不明確な応答への対処法。 - エラーメッセージの解釈。 - タイムアウトへの対応。 - コンテキストの再設定方法。 ### 2. 品質問題 - 不適切なコード生成への対応。 - パフォーマンス問題の解決。 - セキュリティ問題の修正。 - テストカバレッジの改善。 ## 関連情報 - [AIエージェントとの対話プロトコル](interaction-01jpcvxfxs0zr4jqmx1jn4f9re.md) - [AIエージェントの機能と制限](capabilities-01jpcvxfxs0zr4jqmx1jn4f9rh.md) - [AIエージェント活用のベストプラクティス](best-practices-01jpcvxfxs0zr4jqmx1jn4f9rj.md) - [AIエージェントのトラブルシューティング](troubleshooting-01jpcvxfxra1qd2v1btrrz4s2z.md)