signoz-searching-docs

SigNoz ドキュメント

公式の signoz.io ドキュメントと API リファレンスのみを使用してください。すべての回答は取得したドキュメントの内容に基づき、正規のドキュメント URL を引用してください。

ドキュメントへのアクセス

利用できる場合は SigNoz MCP サーバーのツールを優先し、利用できない場合は直接 HTTP で取得してください。

優先：MCP ツール

• signoz_search_docs：インデックス化されたドキュメントコーパスをキーワード検索します。1 つのトピックにつき 2〜6 個のキーワードを searchText として渡します。例：Kubernetes pod logs。プロダクト名や技術名はユーザーが記述したとおりに保ち、「どうすれば」や「お願いします」などの不要な語句は削除してください。質問文全体は渡さないでください。Retention? のように使用できる語句が 1 つしかない場合は、キーワードを補ったり作り出したりせず、その語句だけを渡してください。質問に 2 つの意図が含まれている場合は、2 回に分けて呼び出してください。質問が 1 つのドキュメントセクションに明確に対応する場合は section_slug で絞り込んでください。section_slug は推測せず、以前の結果に含まれていたものを再利用し、スラッグとランキングの挙動についてはツールのパラメーター説明に従ってください。最上位の結果がトピックと無関係な場合は、回答前にキーワードを減らすか変更して 1 回だけ再試行してください。単一の語句の場合は、類義語を使うか、Retention? に対する data retention のように関連する語句を 1 つ追加して再試行してください。
• signoz_fetch_doc：インデックス化された 1 ページの Markdown を取得します。正規の URL または /docs/... パスを渡してください。必要に応じて heading を指定し、セクションを絞り込めます。レスポンスごとに truncation_reason と available_headings を確認してください。返された content が完全だと決めつけないでください。

searchText を空にして signoz_search_docs を呼び出してはいけません。キーワードにはユーザーの質問に含まれる語句を使い、上記の再試行で説明した場合に限り、類義語や関連する語句を追加してください。 URL を指定せずに signoz_fetch_doc を呼び出してはいけません。どちらのツールも、不足している入力を推測しません。 signoz://... URI は MCP リソースです。MCP リソース API を通じて読み取り、signoz_fetch_doc は使用しないでください。このツールが受け付けるのは https://signoz.io/docs/... URL または /docs/... パスのみで、それ以外のスコープは拒否されます。

記憶を頼りに /docs/... URL を作成してはいけません。signoz_fetch_doc に渡すのは signoz_search_docs が返した URL のみです。ページのパスをすでに知っていると思っても、まず検索し、結果から正規の URL を取得してください。

フォールバック：直接 HTTP で取得

MCP ツールを利用できない場合、SigNoz ドキュメントは Accept: text/markdown にネイティブで対応しています。

サイトマップから検索します：

GET https://signoz.io/docs/sitemap.md

特定のページを取得します：

GET https://signoz.io/docs/<path>/
Accept: text/markdown

ワークフロー

1. ドメインを特定する：ユーザーの質問から、計装、OpenTelemetry のセットアップ、クエリ、ダッシュボード、アラート、トラブルシューティング、デプロイ、API ドキュメントのいずれに該当するかを判断します。
2. 以下のヒューリスティクス表を確認する：ヒューリスティクスに該当するものがあれば、回答する前に読んでください。ヒューリスティクスには、ユーザーの環境に合った方法や手順を選ぶための製品上の判断が記載されており、どちらの方法でも役立ちます。
3. 検索して取得する：利用可能なツールに応じて方法を選びます。
   • MCP ツールを利用できる場合：ユーザーの質問からキーワードを 2～6 個（質問に含まれる語が 1 つだけの場合はその語のみ）選んで signoz_search_docs を呼び出します。ドメインを特定のセクションに明確に対応付けられる場合は、section_slug を渡します。上位 1～3 件の結果を読み、選択した URL に対して signoz_fetch_doc を呼び出します（ページが大きく、質問が特定のサブセクションに関する場合は、heading を指定して対象を絞ります）。上位の結果が質問と無関係な場合は、語句を減らすか別の語句を使って（単語 1 つの質問なら類義語を使って）一度だけ再試行します。
   • MCP ツールを利用できない場合：sitemap.md を grep して候補ページを探し、タスクへの直接的な回答度が高いものから 2～5 件を選びます。サイトマップで見つけた URL のみを対象に、Accept: text/markdown を指定して GET します。ヒューリスティクスの対象範囲は限られています。ヒューリスティクス表にないトピックでは、サイトマップをセクションパスごとに確認し、概要ページよりセットアップ、トラブルシューティング、API リファレンスのページを優先します。
   • 質問が限定的な場合はページを 1 つ取得します。セットアップとトラブルシューティング、または方法の選択と言語ガイドにまたがる場合は複数のページを取得します。取得するページ数は少数に抑えます。
4. 回答前に、取得内容の切り捨てに対処する：signoz_fetch_doc が truncation_reason: "size" を返した場合、content は不完全な先頭部分として扱います。質問に最も関連する項目を available_headings から選び、同じ検索結果の URL に対して heading を指定して再取得します。質問に該当する見出しがない場合、または絞り込んだ結果でも必要な内容が取得前に切り捨てられている場合は、取得したドキュメントが不完全であることを明示し、省略された内容や設定の有無について推測しないでください。
5. 取得したドキュメントに基づいて回答し、正規の https://signoz.io/docs/... URL を引用する。
6. 曖昧さには慎重に対処する：複数のページが候補になる場合は、タスクに最も直接的に答えられるページを優先します。回答に実質的な違いが生じる場合に限り、別の候補も示します。

メッセージアクション

最終回答では、SigNoz Skills & MCP 仕様に従って FE ハンドオフアクションを出力します。

• open_docs：主要な引用ページの正規 URL を含めます。ドキュメントを参照した回答では、ユーザーが文脈を確認し、回答を検証しやすいよう、ソースページへのディープリンクが役立ちます。
• follow_up：ドキュメントに基づく回答の次のステップとなるプロンプトを 1～2 個含めます。セットアップガイドの後なら、「最初のコマンドの実行を案内して」や「よくある落とし穴は？」、概念ページの後なら「具体例を見せて」などが適切です。
• **apply_filter`` は出力しないでください。** ドキュメントに関する回答ではエクスプローラーページ用のクエリは生成されません。apply_filter` を出力すると、ユーザーが作業中のクエリを上書きしてしまいます。

そのまま適用するガードレール：SigNoz のドキュメントに関する質問に回答する際は、最終メッセージに主要な引用ページの正規 URL を指定した open_docs アクションを含めてください。

ドメイン別ヒューリスティクス

該当するヒューリスティクスファイルを、ドキュメント取得の前に読んでください。各ファイルには、ユーザーを適切なガイドに誘導するための判断基準が記載されています。

トピック	トリガーとなるキーワード	ヒューリスティクスファイル
ログの送信	logs、log collection、logging、send logs	sending-logs.md