Skip to main content
カスタムプロンプトにより、Kody がコードを分析し、結果を伝達する方法を完全に制御できます。各レビューカテゴリで AI が何を探すか、チームの基準とコミュニケーションスタイルに合わせてサジェストをどのように提示するかをカスタマイズします。

カスタムプロンプト設定にアクセス

組織内のすべてのリポジトリのカスタムプロンプトを設定します

カスタムプロンプトを使用する理由

チーム固有の基準

Kody のレビューをチームのユニークなコーディング標準、アーキテクチャパターン、ベストプラクティスに合わせます

モデルの最適化

BYOK 使用時に特定の AI モデルの強みに最適化されたプロンプトを作成します

フォーカス制御

プロジェクトにとって最も重要な問題に Kody の注意を向け、ノイズを減らします

コミュニケーションスタイル

重大な問題には詳細に、軽微な問題には簡潔に — Kody のサジェストの提示方法をカスタマイズします

カスタムプロンプトの仕組み

カスタムプロンプトは 2 つのレベルで動作します:

カテゴリプロンプト

各レビューカテゴリで Kody が何を探すかを定義します:
フォーカス: コードの正確性と実行上の問題デフォルトのカバレッジ:
  • 実行エラー(未処理の例外)
  • 誤った結果(不正な出力)
  • リソースリーク(ファイル、接続、メモリ)
  • 状態の破損(無効なオブジェクト/データ状態)
  • ロジックエラー(不正な制御フロー)
  • 競合状態(並行アクセスの問題)
最大長: 2000 文字

サジェストプロンプト

Kody が各サジェストを伝達する方法を制御します。これにより、PR コメントに表示されるメッセージの形式とトーンがカスタマイズされます:
カスタムプロンプトは、Kody にサジェストメッセージの書き方を指示します。プロンプトは重大度レベル、問題の説明、提案されたコード、および Kody ルール違反かどうかについてのコンテキストを受け取ります。Kody はこのコンテキストとプロンプトを使用して各サジェストに適切なメッセージを生成します。 チームのニーズに基づいて、重大な問題には詳細な説明を、軽微な問題には簡潔なフィードバックなど、トーン、詳細レベル、コミュニケーションスタイルをカスタマイズできます。

外部参照

すべてのカスタムプロンプト(カテゴリ、サジェスト、PR サマリー)は、Kody がアクセスできるコードベースの実際のファイルへの参照をサポートします。更新を保存すると、Kody は自動的に外部参照を検出し、将来のレビューのために解決します。
  • 編集中のリポジトリのファイルを指定するには @file:path/to/file.ts を使用します。Kody はまずローカルでパスを見つけようとします。
  • 別のリポジトリのファイルを参照する場合やグローバルレベルでプロンプトを編集する場合は @repo:org/project を含めます。
  • モデルが確実に正しいファイルを見つけられるように、プレースホルダーではなく正確な blob スタイルのパスを優先してください。
  • 保存後、Kody はバックグラウンドで参照を処理します。解決が完了したことを確認するために、プロンプトエディタ横のステータスインジケーターを確認してください。

ベストプラクティス

コンテキストに特化する

良い例:コンテキスト特化

悪い例:汎用的すぎる

プロンプト間の冗長性を避ける

各カテゴリは明確なフォーカスを持つべきです。異なるプロンプト間で同じ指示を繰り返さないでください。
バグカテゴリ: Java サービスの実行の正確性、ヌルポインタ例外、リソースのクリーンアップに焦点を当てます。セキュリティカテゴリ: API エンドポイントの SQL インジェクション、XSS、CSRF に焦点を当てます。入力のサニタイズとパラメータ化クエリを検証します。パフォーマンスカテゴリ: データ処理での N+1 クエリ、データベースインデックスの欠如、非効率なループに焦点を当てます。結果: 各プロンプトは明確で重複しないフォーカスを持っています。
バグカテゴリ: ヌルポインタ、SQL インジェクション、遅いクエリを確認します。セキュリティカテゴリ: SQL インジェクション、ヌルポインタ、パフォーマンス問題を探します。パフォーマンスカテゴリ: 遅いクエリ、ヌルポインタ、セキュリティの脆弱性を見つけます。問題: すべてのプロンプトが重複しており、モデルを混乱させてレビュー品質を低下させます。

例の使用に注意する

これはパターンを広く説明し、複数のバリエーションを捕捉します。

サジェストをスキャンしやすくする

サジェストプロンプトでは、開発者が一度に多くをレビューするため、メッセージをスキャンしやすくします:
明確な階層、重要な情報を最初に

コンテキストを有意義に使用する

本当の理由がある場合にのみサジェスト形式を差別化します:
明確な区別:ルールは要件、サジェストは推奨

ユースケース

シナリオ: HIPAA コンプライアンス要件を持つ医療アプリケーションカスタムセキュリティプロンプト:
メリット: Kody は一般的なセキュリティレビューが見逃す可能性のあるコンプライアンス固有の問題を捕捉します。
シナリオ: 特定のパターンを持つ React/Node.js アプリケーションカスタムバグプロンプト:
メリット: レビューはスタック固有の落とし穴にレーザーフォーカスされます。
シナリオ: コスト最適化のために BYOK 経由で Gemini 2.5 Flash を使用カスタムパフォーマンスプロンプト:
メリット: Gemini が非常に得意とする構造化された出力形式で、レビュー品質が向上します。
シナリオ: クリティカルな問題には詳細な説明を、軽微な問題には簡潔なフィードバックを望むカスタムサジェストプロンプト:
メリット: クリティカルな問題は追加のコンテキストを得て、軽微な問題は簡潔に保たれ、レビュー効率が向上します。
シナリオ: チームは最小限のアクション可能なフィードバックを好むカスタムサジェストプロンプト:
メリット: すべてのサジェストが短く、要点を押さえています。
シナリオ: ジュニア開発者は詳細な説明から恩恵を受けるカスタムサジェストプロンプト:
メリット: すべてのサジェストに重要性についての教育的なコンテキストが含まれます。
シナリオ: Kody ルールは厳格な要件、サジェストは推奨カスタムサジェストプロンプト:
メリット: 必須ルールとオプションのサジェストを明確に区別します。

トラブルシューティング

症状: カスタマイズ後に低価値のサジェストが多すぎる解決策:
  • プロンプトをより具体的でフォーカスしたものにする
  • 無視したいパターンに対して除外を追加する
  • サジェスト制御で最小重大度しきい値を上げる
  • カテゴリプロンプト間の冗長性を確認する
症状: Kody が検出すべき問題を検出しない解決策:
  • プロンプトが狭すぎたり例に特化しすぎていないか確認する
  • カスタマイズしなかったカテゴリに問題が該当するか確認する
  • デフォルトにリセットして問題が検出されるか試す
  • 問題が異なる重大度で分類されている可能性を検討する
症状: 同じタイプの問題が時々フラグされ、時々されない解決策:
  • プロンプトが明確で曖昧でないことを確認する
  • 異なるプロンプト間の矛盾する指示を取り除く
  • 特定しすぎた例を使用していないか確認する
  • プライマリ/フォールバックの異なるモデルが異なる能力を持つかどうかを検討する
症状: カスタムプロンプトを使用したいが、どこから始めればよいかわからない解決策:
  • まず 1 週間デフォルトのレビューを実行する
  • 誤検知または見逃した問題のパターンに注目する
  • それらのパターンに関連する特定のプロンプトのみをカスタマイズする
  • 明確なニーズが見えるまで他のプロンプトはデフォルトのままにする

よくある質問

設定した場所によって異なります:
  • グローバル設定: 組織内のすべてのリポジトリに適用されます
  • リポジトリごとの設定: そのリポジトリのグローバル設定をオーバーライドします
これにより、必要に応じてリポジトリ固有のオーバーライドを使用しながら、組織全体の標準を持つことができます。
はい。設定の任意のプロンプトをクリックしてデフォルトのコンテンツを表示します。
変更は新しいレビューにのみ影響します。@kody start-review で再実行して新しいプロンプトを既存の PR に適用します。
いいえ。カスタムプロンプトは意図的な変更を確保するために Web のみです。他の設定(無視パス、ブランチ)は kodus-config.yml を使用できます。
明確で具体的なニーズがあるプロンプトのみカスタマイズしてください。改善の恩恵を受けるために他はデフォルトのままにしてください。1〜2 個のプロンプトから始めてください。
シームレスに機能します。モデルの強みに合わせてプロンプトを調整してください。プライマリとフォールバックの両方が同じカスタムプロンプトを使用します。
カテゴリプロンプトは各レビューカテゴリで Kody が何を分析するかを制御します。サジェストプロンプトは Kody がチームに結果をどのように提示するかを制御します。両方を独立してカスタマイズできます。
はい。サジェストプロンプトは太字、斜体、コードブロック、リンクを含む標準的なマークダウン形式をサポートします。
Kody はデフォルトのサジェスト形式にフォールバックし、設定でエラーを通知します。
はい。isKodyRule 変数を使用して、同じプロンプト内でルールとサジェストに対して異なるメッセージを作成します。