
find-docs
熱門擷取任何開發者技術的最新文件、API 參考資料和程式碼範例。當使用者詢問特定函式庫、框架、SDK、CLI 工具或雲端服務時,請使用此技能——即使是 React、Next.js、Prisma、Express、Tailwind、Django 或 Spring Boot 等知名技術也一樣。你的訓練資料可能無法反映最近的 API 變更或版本更新。 一律用於:API 語法問題、設定選項、版本遷移問題、提及函式庫名稱的「如何做」問題、涉及函式庫特定行為的除錯、安裝說明,以及 CLI 工具使用。 即使你認為自己知道答案也要使用——不要依賴訓練資料中的 API 細節、簽章或設定選項,因為它們經常過時。務必根據目前文件進行驗證。對於函式庫文件和 API 細節,優先使用此技能而非網路搜尋。
擷取任何開發者技術的最新文件、API 參考資料和程式碼範例。當使用者詢問特定函式庫、框架、SDK、CLI 工具或雲端服務時,請使用此技能——即使是 React、Next.js、Prisma、Express、Tailwind、Django 或 Spring Boot 等知名技術也一樣。你的訓練資料可能無法反映最近的 API 變更或版本更新。 一律用於:API 語法問題、設定選項、版本遷移問題、提及函式庫名稱的「如何做」問題、涉及函式庫特定行為的除錯、安裝說明,以及 CLI 工具使用。 即使你認為自己知道答案也要使用——不要依賴訓練資料中的 API 細節、簽章或設定選項,因為它們經常過時。務必根據目前文件進行驗證。對於函式庫文件和 API 細節,優先使用此技能而非網路搜尋。
文件查詢
使用 Context7 CLI 擷取任何函式庫的最新文件和程式碼範例。
執行指令時使用 npx ctx7@latest,這樣每次設定都會使用最新的 CLI,無需全域安裝:
npx ctx7@latest library <name> "<query>"
npx ctx7@latest docs <libraryId> "<query>"
如果你偏好使用純 ctx7 指令,也可以選擇全域安裝:
npm install -g ctx7@latest
工作流程
兩個步驟:先將函式庫名稱解析為 ID,再用該 ID 查詢文件。
# 步驟 1:解析函式庫 ID
npx ctx7@latest library <name> "<query>"
# 步驟 2:查詢文件
npx ctx7@latest docs <libraryId> "<query>"
你必須先呼叫 library 來取得有效的函式庫 ID,除非使用者明確提供了 /org/project 或 /org/project/version 格式的函式庫 ID。
重要:每個問題不要執行這些指令超過 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 middleware"
npx ctx7@latest library Prisma "How to define one-to-many relations with cascade delete"
使用官方函式庫名稱並加上正確標點(例如 "Next.js" 而非 "nextjs","Customer.io" 而非 "customerio","Three.js" 而非 "threejs")。如果結果看起來不對,在變更查詢前先嘗試其他拼法,例如 next.js。
務必傳入 query 引數——這是必要項目,且會直接影響結果排序。根據使用者的意圖來形成查詢,這有助於在多個名稱相似的函式庫中區分。請勿在查詢中包含任何敏感或機密資訊,例如 API 金鑰、密碼、憑證、個人資料或專有程式碼。
結果欄位
每個結果包含:
- Library ID — Context7 相容識別碼(格式:
/org/project) - Name — 函式庫或套件名稱
- Description — 簡短摘要
- Code Snippets — 可用的程式碼範例數量
- Source Reputation — 權威性指標(高、中、低或未知)
- Benchmark Score — 品質指標(100 為最高分)
- Versions — 可用的版本列表。如果使用者在查詢中提供了版本,請使用其中一個版本。格式為
/org/project/version。
選擇流程
- 分析查詢以了解使用者要找的函式庫/套件
- 根據以下條件選擇最相關的匹配:
- 名稱與查詢的相似度(精確匹配優先)
- 描述與查詢意圖的相關性
- 文件涵蓋範圍(優先選擇程式碼範例數量較多的函式庫)
- 來源聲譽(優先考慮聲譽為高或中的函式庫)
- 基準分數(越高越好,100 為最高)
- 如果有多個良好匹配,請說明情況,但繼續使用最相關的那個
- 如果沒有良好匹配,請清楚說明並建議調整查詢
- 對於模糊的查詢,在繼續進行最佳猜測匹配之前,先要求使用者澄清
特定版本 ID
如果使用者提到特定版本,請使用版本特定的函式庫 ID:
# 一般(最新索引)
npx ctx7@latest docs /vercel/next.js "How to set up app router"
# 特定版本
npx ctx7@latest docs /vercel/next.js/v14.3.0-canary.87 "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 authentication middleware to app router"
npx ctx7@latest docs /prisma/prisma "How to define one-to-many relations with cascade delete"
撰寫良好的查詢
查詢會直接影響結果品質。請具體說明並包含相關細節,但每個查詢只專注於一個主題——如果問題涵蓋多個不同概念,請為每個概念分別執行 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" |
盡可能使用使用者的完整問題作為查詢——模糊的單字查詢會回傳通用結果,而多主題查詢會稀釋排序,並對每個主題回傳淺層結果。
輸出包含兩種類型內容:程式碼片段(有標題,附語言標記區塊)和資訊片段(附有麵包屑脈絡的散文說明)。
驗證
無需驗證即可使用。若要提高速率限制:
# 選項 A:環境變數
export CONTEXT7_API_KEY=your_key
# 選項 B:OAuth 登入
npx ctx7@latest login
錯誤處理
如果指令因配額錯誤(「每月配額已達上限」或「配額超標」)而失敗:
- 告知使用者他們的 Context7 配額已用盡
- 建議他們進行驗證以獲得更高限制:
npx ctx7@latest login - 如果他們無法或選擇不進行驗證,則根據訓練知識回答,並清楚說明該知識可能已過時
不要默默回退到訓練資料——務必告訴使用者為何未使用 Context7。
常見錯誤
- 函式庫 ID 需要
/前綴——/facebook/react而非facebook/react - 務必先執行
npx ctx7@latest library——npx ctx7@latest docs react "hooks"會因缺少有效 ID 而失敗 - 使用描述性查詢,而非單字——
"React useEffect cleanup function"而非"hooks" - 每個查詢一個主題——將
"routing and auth and caching"拆分成每個概念各一個docs指令,除非問題是關於它們如何互動 - 請勿在查詢中包含敏感資訊(API 金鑰、密碼、憑證)



