find-docs

ドキュメントの検索

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

次のように、context7 CLI を直接実行します。

pnpx ctx7@latest <command>

ワークフロー

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

# Step 1: Resolve library ID
ctx7 library <name> <query>

# Step 2: Query documentation
ctx7 docs <libraryId> <query>

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

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

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

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

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

句読点を含む正式なライブラリ名を使用してください（nextjs ではなく "Next.js"、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 - 利用可能な場合はバージョンの一覧。ユーザーがクエリでバージョンを指定した場合は、その中から 1 つを使用してください。形式は /org/project/version です。

選択の手順

1. クエリを分析して、ユーザーが探しているライブラリまたはパッケージを把握します
2. 次の点に基づいて、最も関連性の高い候補を選択します。
   • クエリとの名前の類似性（完全一致を優先）
   • ユーザーの意図に対する説明の関連性
   • ドキュメントの充実度（コードスニペット数が多いライブラリを優先）
   • ソースの信頼性（High または Medium の評価をより信頼できるものとして考慮）
   • ベンチマークスコア（高いほど良く、100 が最高）
3. 有力な候補が複数ある場合はその旨を伝えたうえで、最も関連性の高い候補を選択します
4. 有力な候補がない場合は、その旨を明確に伝え、クエリの改善案を提示します
5. クエリが曖昧な場合は、推測で候補を選ぶ前に確認を求めます

バージョン固有の ID

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

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

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

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

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

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

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

ユーザーのプログラミング言語が分かっている場合は --language を追加し、その言語の例が最初に表示されるようにしてください。

ctx7 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"

完了するタスクではなく、ドキュメントで調べたい内容を説明してください。1語だけのクエリでは一般的な結果が返されます。複数トピックのクエリでは、各トピックについて浅い結果が返されます。

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

認証

認証なしで利用できます。より高いレート制限を利用するには：

# Option A: environment variable
export CONTEXT7_API_KEY=your_key

# Option B: OAuth login
ctx7 login

エラー処理

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

1. ユーザーに Context7 のクォータを使い切ったことを伝えてください
2. より高い制限を利用するため、認証を勧めてください：ctx7 login
3. 認証できない、または認証しないことを選んだ場合は、学習データに基づいて回答し、情報が古い可能性があることを明確に伝えてください

学習データに黙って切り替えないでください。Context7 を使用しなかった理由を必ずユーザーに伝えてください。

よくある間違い

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