仕組み
- メッセージ送信時に、ClickHouse Assistant chat エージェントがこのファイルを自動的に読み込みます
- 内容は構造化されたコンテンツタグ内に配置され、エージェントのシステムプロンプトに挿入されます
- これらの指示は、そのサービス内のすべての ClickHouse Assistant chat の会話に適用されます
AGENTS.md の作成
1
保存クエリを作成する
- Cloud Console で新しいクエリを作成します
- 名前を “AGENTS.md” に正確に設定します (大文字と小文字は区別されます)
- クエリテキストのエディタにカスタムの指示を記述します (実際の SQL は入力しません)
- クエリを保存します
2
指示を追加する
明確で実行しやすい表現で指示を構成します。以下を含めてください。
- ビジネスルールと計算式
- データ構造に関するガイダンス
- ドメイン固有の用語
- 一般的なクエリパターン
- パフォーマンス最適化のルール
ベストプラクティス
コンテキストを有限のリソースとして扱う
適切な粒度を見極める
- 具体的すぎる: 壊れやすい if-else ロジックをハードコードしてしまい、脆さや保守の複雑さを招く
- 曖昧すぎる: 具体的な手がかりを示せず、共有された文脈があることを誤って前提にしてしまう高レベルなガイダンス
構造化されたセクションで整理する
多様で代表的な例を示す
最小限にしつつ、必要な内容は漏れなく含める
- 頻繁に必要となる指示だけを含める
- 簡潔にする — コンテキストが長すぎると「コンテキストの劣化」によりパフォーマンスが低下する
- 古くなったルールやほとんど使われないルールは削除する
- 望ましい挙動を導くのに十分な情報を確保する