signoz-docs について
signoz-docsは、SigNozの公式ドキュメントとAPIリファレンスに基づいて回答するスキルです。ページの検索・選定・引用を案内し、取得した内容を根拠として回答します。
主な機能
- 01サイトマップでページを検索
- 02Markdown形式でページを取得
- 03関連する公式ページを選定
- 04正規ドキュメントURLを引用
活用シーン
- 01SigNozの設定ガイドを探す
- 02クエリやアラートについて回答
- 03SigNoz APIリファレンスを調べる
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ signoz/ agent-skills --skill signoz-docsインストール後、Claude Code で/signoz-docsを入力して読み込まれたか確認します。
同梱ファイルREADME.mdheuristics/sending-logs.md
詳細
SigNoz Docs
公式の signoz.io ドキュメントと API リファレンスのみを使用してください。取得したドキュメントの内容に基づいてすべての回答を作成し、正式なドキュメント URL を引用してください。
ドキュメントへのアクセス
SigNoz のドキュメントは Accept: text/markdown に対応しています。HTML をスクレイピングする代わりに、ドキュメントページを Markdown として取得してください。
ページを探す
サイトマップを使って、候補となるページを検索します。
GET https://signoz.io/docs/sitemap.md
ページを取得する
次のようにリクエストすると、任意のドキュメントページを Markdown として取得できます。
GET https://signoz.io/docs/<path>/
Accept: text/markdown
たとえば、ログの概要ページを取得する場合は次のとおりです。
GET https://signoz.io/docs/logs-management/overview/
Accept: text/markdown
ワークフロー
- ユーザーの質問からドメインを特定します:計装、OpenTelemetry のセットアップ、クエリ、ダッシュボード、アラート、トラブルシューティング、デプロイ、API ドキュメントのいずれかです。
- 以下のヒューリスティクステーブルを確認します。該当するヒューリスティックがあれば、ドキュメントページを選ぶ前にそのファイルを読みます。
sitemap.mdを検索し、ユーザーの製品領域、環境、言語、タスクに合う候補ページを探します。- タスクの遂行に直接役立つ公式ページを2~5件選び、順位付けします。
- 上位のページのみを
Accept: text/markdownを指定して Markdown として取得します。- 1つのセットアップガイド、トラブルシューティングページ、API リファレンスに明確に対応する限定的な質問には、1ページを取得します。
- 収集方法の選択と言語ガイド、セットアップとトラブルシューティング、概要と正確な API/認証情報など、タスクが複数のニーズに明らかにまたがる場合は、複数ページを取得します。
- 取得するページは、目的を明確にしたうえで少数に絞ります。キーワードが共通しているだけの関連性の薄いページは取得しないでください。
- 取得したドキュメントに基づいて回答し、正式な
https://signoz.io/docs/...URL を引用します。 - 曖昧さには意図的に対処します:複数のページが候補となる場合は、タスクの遂行に最も直接役立つページを優先し、回答に実質的な違いがある場合に限って代替ページにも言及します。
順位付けのヒント
- ユーザーが操作方法を知りたい場合は、概要ページよりセットアップ、トラブルシューティング、API リファレンスのページを優先してください。
- ユーザーのランタイム、言語、デプロイ環境、SigNoz の製品領域に合ったページを優先してください。
- API に関する質問では、一般的なガイドよりも、該当するエンドポイント/認証/リファレンスのページを優先してください。
- このスキルを適用する場合は、公式の
signoz.ioドキュメントページのみを使用してください。
ドメイン別ヒューリスティック
ドキュメントを取得する前に、該当するヒューリスティックファイルを読みます。各ファイルには、ユーザーを適切なガイドに誘導するための判断ロジックが含まれています。
| トピック | トリガーキーワード | ヒューリスティックファイル |
|---|---|---|
| ログの送信 | logs, log collection, logging, send logs | sending-logs.md |
コメント
Markdown 対応