find-docs

作者: upstash

使用 Context7 CLI 擷取任何函式庫的最新文件與程式碼範例。

npx skills add https://github.com/upstash/context7 --skill find-docs

Documentation Lookup

Retrieve current documentation and code examples for any library using the Context7 CLI.

Run commands with npx ctx7@latest so setup always uses the latest CLI without a global install:

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

Optionally install globally if you prefer a bare ctx7 command:

npm install -g ctx7@latest

Workflow

Two-step process: resolve the library name to an ID, then query docs with that ID.

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

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

You MUST call library first to obtain a valid library ID UNLESS the user explicitly provides a library ID in the format /org/project or /org/project/version.

IMPORTANT: Do not run these commands more than 3 times per question. If you cannot find what you need after 3 attempts, use the best result you have.

Step 1: Resolve a Library

Resolves a package/product name to a Context7-compatible library ID and returns matching libraries.

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"

Use the official library name with proper punctuation (e.g., "Next.js" not "nextjs", "Customer.io" not "customerio", "Three.js" not "threejs"). If results look wrong, try alternate spellings such as next.js before changing the query.

Always pass a query argument — it is required and directly affects result ranking. Use the user's intent to form the query, which helps disambiguate when multiple libraries share a similar name. Do not include any sensitive or confidential information such as API keys, passwords, credentials, personal data, or proprietary code in your query.

Result fields

Each result includes:

  • Library ID — Context7-compatible identifier (format: /org/project)
  • Name — Library or package name
  • Description — Short summary
  • Code Snippets — Number of available code examples
  • Source Reputation — Authority indicator (High, Medium, Low, or Unknown)
  • Benchmark Score — Quality indicator (100 is the highest score)
  • Versions — List of versions if available. Use one of those versions if the user provides a version in their query. The format is /org/project/version.

Selection process

  1. Analyze the query to understand what library/package the user is looking for
  2. Select the most relevant match based on:
    • Name similarity to the query (exact matches prioritized)
    • Description relevance to the query's intent
    • Documentation coverage (prioritize libraries with higher Code Snippet counts)
    • Source reputation (consider libraries with High or Medium reputation more authoritative)
    • Benchmark score (higher is better, 100 is the maximum)
  3. If multiple good matches exist, acknowledge this but proceed with the most relevant one
  4. If no good matches exist, clearly state this and suggest query refinements
  5. For ambiguous queries, request clarification before proceeding with a best-guess match

Version-specific IDs

If the user mentions a specific version, use a version-specific library 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/v14.3.0-canary.87 "How to set up app router"

The available versions are listed in the library command output. Use the closest match to what the user specified.

Step 2: Query Documentation

Retrieves up-to-date documentation and code examples for the resolved library.

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"

Writing good queries

The query directly affects the quality of results. Be specific and include relevant details, but keep each query to one topic — if the question spans multiple distinct concepts, run a separate docs command per concept instead of combining them, unless the question is about how the concepts interact. Do not include any sensitive or confidential information such as API keys, passwords, credentials, personal data, or proprietary code in your query.

QualityExample
Good"How to set up authentication with JWT in Express.js"
Good"React useEffect cleanup function with async operations"
Bad (too vague)"auth"
Bad (too vague)"hooks"
Bad (too broad)"routing and auth and caching in Next.js"

Describe what to look up in the library's documentation, rather than the task to complete — vague one-word queries return generic results, and multi-topic queries dilute ranking and return shallow results for each topic.

The output contains two types of content: code snippets (titled, with language-tagged blocks) and info snippets (prose explanations with breadcrumb context).

Authentication

Works without authentication. For higher rate limits:

# Option A: environment variable
export CONTEXT7_API_KEY=your_key

# Option B: OAuth login
npx ctx7@latest login

Error Handling

If a command fails with a quota error ("Monthly quota reached" or "quota exceeded"):

  1. Inform the user their Context7 quota is exhausted
  2. Suggest they authenticate for higher limits: npx ctx7@latest login
  3. If they cannot or choose not to authenticate, answer from training knowledge and clearly note it may be outdated

Do not silently fall back to training data — always tell the user why Context7 was not used.

Common Mistakes

  • Library IDs require a / prefix — /facebook/react not facebook/react
  • Always run npx ctx7@latest library first — npx ctx7@latest docs react "hooks" will fail without a valid ID
  • Use descriptive queries, not single words — "React useEffect cleanup function" not "hooks"
  • One topic per query — split "routing and auth and caching" into a separate docs command per concept, unless the question is about how they interact
  • Do not include sensitive information (API keys, passwords, credentials) in queries

來自 upstash 的更多技能

context7-docs
upstash
獲取任何函式庫、框架、SDK、CLI 工具或雲端服務的最新文件與程式碼範例。當使用者詢問特定…時使用。
official
context7-mcp
upstash
當使用者詢問關於函式庫、框架、API 參考資料,或需要程式碼範例時,應使用此技能。適用於設定問題、程式碼…
official
ctx7-cli
upstash
使用 ctx7 CLI 來擷取函式庫文件、管理 AI 編碼技能,以及設定 Context7 MCP。當使用者提到「ctx7」或「context7」時啟動…
official
docs
upstash
從 Context7 擷取並查詢任何程式庫或框架的最新文件與程式碼範例。適用於撰寫依賴於…的程式碼時。
official
documentation-lookup
upstash
擷取當前函式庫文件與程式碼範例,而非依賴訓練資料。將函式庫名稱解析為 Context7 文件 ID,再查詢設定、配置與 API 參考資訊。支援主要框架與函式庫:React、Vue、Svelte、Next.js、Express、Prisma、Supabase、Tailwind 等。針對設定問題、程式碼生成請求及框架特定查詢自動啟用。回傳具版本感知的文件與官方程式碼...
official
redis-js
upstash
使用 Upstash Redis JavaScript/TypeScript SDK 進行無伺服器 Redis 操作。適用於快取、會話儲存、速率限制、排行榜、全文…
official
upstash-search-js
upstash
涵蓋 Upstash Search 快速入門、核心概念及 TypeScript SDK 使用方式的文檔技能入口點。當使用者詢問如何開始使用時使用…
official
upstash/search TypeScript SDK
upstash
upstash/search-typescript-sdk — 一個可安裝的AI代理技能,由upstash/search-js發布。
official