find-docs

ドキュメントの検索

Context7 CLI を使用して、あらゆるライブラリの最新ドキュメントとコード例を取得します。

グローバルインストールなしで常に最新の CLI を使用できるよう、npx ctx7@latest でコマンドを実行してください。

npx ctx7@latest library <name> "<query>"
npx ctx7@latest docs <libraryId> "<query>"

必要に応じて、ctx7 コマンドをそのまま使用できるようにグローバルインストールすることもできます。

npm install -g ctx7@latest

ワークフロー

ライブラリ名を ID に解決し、その ID でドキュメントを検索する 2 段階のプロセスです。

# Step 1: Resolve library ID
npx ctx7@latest library <name> "<query>"

# Step 2: Query documentation
npx ctx7@latest docs <libraryId> "<query>"

有効なライブラリ ID を取得するため、ユーザーが /org/project または /org/project/version 形式でライブラリ ID を明示的に指定している場合を除き、必ず最初に library を呼び出してください。

重要：1 つの質問に対して、これらのコマンドを 3 回を超えて実行しないでください。3 回試しても必要な情報が見つからない場合は、最も良い結果を使用してください。

ステップ 1：ライブラリを解決する

パッケージ名または製品名を Context7 互換のライブラリ ID に解決し、一致するライブラリを返します。

npx ctx7@latest library React "How to clean up useEffect with async operations"
npx ctx7@latest library "Next.js" "How to set up app router with a proxy"
npx ctx7@latest library Prisma "How to define one-to-many relations with cascade delete"

句読点を正しく含む正式なライブラリ名を使用してください（例：「nextjs」ではなく「Next.js」、「customerio」ではなく「Customer.io」、「threejs」ではなく「Three.js」）。結果が正しくないように見える場合は、クエリを変更する前に「next.js」などの別の表記を試してください。

query 引数は必ず指定してください。これは必須であり、結果のランキングに直接影響します。複数のライブラリに似た名前がある場合の判別に役立つよう、ユーザーの意図をもとにクエリを作成してください。API キー、パスワード、認証情報、個人データ、独自コードなど、機密情報や秘密情報をクエリに含めないでください。

結果フィールド

各結果には次の情報が含まれます。

• Library ID — Context7 互換の識別子（形式：/org/project）
• Name — ライブラリ名またはパッケージ名
• Description — 簡単な説明
• Code Snippets — 利用可能なコード例の数
• Source Reputation — 信頼性の指標（High、Medium、Low、Unknown）
• Benchmark Score — 品質の指標（100 が最高スコア）
• Versions — 利用可能な場合はバージョンの一覧。ユーザーがクエリでバージョンを指定した場合は、そのいずれかを使用してください。形式は /org/project/version です。

選択プロセス

1. クエリを分析し、ユーザーが探しているライブラリ／パッケージを理解します
2. 次の項目をもとに、最も関連性の高い結果を選びます。
   • クエリとの名前の類似性（完全一致を優先）
   • ユーザーの意図との説明の関連性
   • ドキュメントの網羅性（コード例の数が多いライブラリを優先）
   • ソースの信頼性（High または Medium の評価がより高い信頼性を示します）
   • ベンチマークスコア（高いほど良く、100 が最高です）
3. 有力な候補が複数ある場合はその旨を伝えたうえで、最も関連性の高いものを選びます
4. 適切な候補がない場合は、その旨を明確に伝え、クエリの修正案を提示します
5. 曖昧なクエリの場合は、最も有力な候補を推測して進める前に、確認を求めます

バージョン固有の ID

ユーザーが特定のバージョンを指定した場合は、バージョン固有のライブラリ ID を使用してください。

# General (latest indexed)
npx ctx7@latest docs /vercel/next.js "How to set up app router"

# Version-specific
npx ctx7@latest docs /vercel/next.js/v16.2.9 "How to set up app router"

利用可能なバージョンは library コマンドの出力に表示されます。指定されたバージョンに最も近いものを使用してください。

ステップ 2：ドキュメントを検索する

解決済みのライブラリについて、最新のドキュメントとコード例を取得します。

npx ctx7@latest docs /facebook/react "How to clean up useEffect with async operations"
npx ctx7@latest docs /vercel/next.js "How to add an authentication proxy to app router"
npx ctx7@latest docs /prisma/prisma "How to define one-to-many relations with cascade delete"

ユーザーが使用するプログラミング言語がわかっている場合は、--language を追加すると、その言語のコード例が優先して表示されます。

npx ctx7@latest docs /websites/twilio "How to send an SMS" --language Ruby

良いクエリを書く

クエリは結果の品質に直接影響します。具体的にして、関連する詳細を含めます。ただし、各クエリは1つのトピックに絞ってください。質問が複数の異なる概念にまたがる場合は、概念同士の関係について尋ねるのでない限り、組み合わせずに概念ごとに別の docs コマンドを実行してください。クエリには、APIキー、パスワード、認証情報、個人データ、独自コードなど、機密情報や秘密情報を含めないでください。

品質	例
良い	"How to set up authentication with JWT in Express.js"
良い	"React useEffect cleanup function with async operations"
悪い（曖昧すぎる）	"auth"
悪い（曖昧すぎる）	"hooks"
悪い（範囲が広すぎる）	"routing and auth and caching in Next.js"

完了すべきタスクではなく、ライブラリのドキュメントで何を調べるかを説明してください。曖昧な一語だけのクエリでは一般的な結果しか返らず、複数トピックを含むクエリではランキングが分散し、各トピックについて浅い結果しか得られません。

出力には、コードスニペット（タイトル付きで、言語タグのあるブロック）と情報スニペット（パンくずリストのコンテキストを含む文章による説明）の2種類のコンテンツが含まれます。

認証

認証なしで利用できます。レート制限を引き上げるには：

# Option A: environment variable
export CONTEXT7_API_KEY=your_key

# Option B: OAuth login
npx ctx7@latest login

エラー処理

コマンドがクォータエラー（「Monthly quota reached」または「quota exceeded」）で失敗した場合：

1. Context7 のクォータを使い切ったことをユーザーに伝えます
2. 上限を引き上げるため、認証するよう提案します：npx ctx7@latest login
3. 認証できない場合、または認証しないことを選んだ場合は、学習済みの知識に基づいて回答し、情報が古い可能性があることを明確に伝えます

Context7 を使用しなかった理由を必ずユーザーに伝えてください。学習済みデータに黙ってフォールバックしてはいけません。

よくある間違い

• ライブラリ ID には / プレフィックスが必要です。facebook/react ではなく /facebook/react を使用します
• まず必ず npx ctx7@latest library を実行します。有効な ID がないと npx ctx7@latest docs react "hooks" は失敗します
• 一語だけではなく、説明的なクエリを使用します。"hooks" ではなく "React useEffect cleanup function" を指定します
• クエリごとにトピックを1つにします。概念同士の関係について尋ねるのでない限り、"routing and auth and caching" は概念ごとに別の docs コマンドに分けます
• クエリに機密情報（APIキー、パスワード、認証情報）を含めないでください