search-docs について
Documentation Search Skillは、ImageKitのsearch_docsツールを使う前のクエリ作成と情報源の選択をエージェントに案内します。検索結果の引用方法や、回答が得られない場合の対応も定めています。
主な機能
- 01ImageKitドキュメント検索の指針
- 02具体的な検索クエリへの書き換え
- 03タスクに応じた情報源の選択
- 04検索結果の引用形式
- 05回答が見つからない場合の対応
活用シーン
- 01ImageKitの機能対応状況の確認
- 02APIやSDKの詳細の検索
- 03料金や設定方法の確認
- 04コミュニティ情報を使った問題調査
MCP 対応
ImageKitのsearch_docsツールの利用方法として、クエリの準備、情報源の選択、検索結果の引用を案内します。
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ imagekit-developer/ skills --skill search-docsインストール後、Claude Code で/search-docsを入力して読み込まれたか確認します。
詳細
ドキュメント検索スキル
以下のガイドラインに従ってクエリとソースを選択してから、search_docs を呼び出し、ここに記載されたルールに従って結果を提示します。
使用するタイミング
- ユーザーが ImageKit の機能、性能、サービスについて質問した場合
- 変換ビルダーで問題が発生し、パラメーターや制限に関する情報が必要な場合
- ユーザーが API、設定、料金、DAM 機能について質問した場合
- ImageKit が特定の機能に対応しているか確認する必要がある場合
- SDK の使用例や API リファレンスの詳細を探す必要がある場合
ツールのパラメーター
必須:query — ImageKit に関する明確で具体的な質問(「クエリの作成」を参照)
任意:sources 配列(デフォルト:["imagekit_guides", "imagekit_community"])
imagekit_guides:公式ガイドとチュートリアルimagekit_community:ユーザーが作成したコンテンツや実用的な解決策。トラブルシューティングや実際のユースケースに役立ちます。imagekit_api_references:技術的な API の詳細imagekit_sdk:SDK の実装例
クエリの作成
ルール:ツールを呼び出す前に、曖昧なユーザーの質問は必ず具体的で検索しやすいクエリに書き換えてください。
| ユーザーの質問 | 悪いクエリ(渡さないでください) | 良いクエリ |
|---|---|---|
| 「ImageKit について教えて」 | 「ImageKit について教えて」 | 「ImageKit の機能の概要、画像最適化、CDN」 |
| 「アップロード方法は?」 | 「アップロード」 | 「ImageKit のアップロード API を使ってファイルをアップロードする方法」 |
| 「料金について」 | 「料金」 | 「ImageKit の料金プランと拡張ユニットのコスト」 |
| 「背景を削除できますか?」 | 「背景削除」 | 「ImageKit の AI 変換を使って背景を削除する方法」 |
ソースの選択
| ユースケース | ソース |
|---|---|
| 一般的な機能 | ["imagekit_guides", "imagekit_community"] |
| API の詳細 | ["imagekit_guides", "imagekit_api_references"] |
| SDK の例 | ["imagekit_sdk", "imagekit_guides", "imagekit_community"] |
| トラブルシューティング | ["imagekit_community", "imagekit_guides"] |
Imagekit コミュニティ
- 実際の解決策、トラブルシューティング、ユーザーの体験を確認するのに役立ちます
- 公式ガイドにはない実用的なヒントが含まれている場合があります
- コミュニティのソースは必ず含めてください。特にトラブルシューティングや実際のユースケースでは、公式ドキュメントにない見解や解決策が得られることがあります。
結果の扱い
必ずソースを引用してください:
References:
1. [Title]: [URL]
結果で質問に回答できない場合は、その旨を伝え、ImageKit サポートへの問い合わせを提案してください。
注意点
- 具体的なクエリほど良い結果が得られます(「ImageKit について教えて」ではなく「API を使って背景を削除する方法」)。
- 複数回の検索が必要な場合があります。最初の検索で不十分な場合は、クエリを調整してください。
- コミュニティのソースは実際の解決策を提供し、公式ガイドは信頼できる情報源です。
コメント
Markdown 対応