Documentation Lookup skill

Retrieves up-to-date documentation, API references, and code examples for any developer technology.

by upstash·MIT license·GitHub ↗

★ 62,297 Stars on the repo·Checked

npx degit upstash/context7/skills/find-docs#master ~/.claude/skills/find-docs

SKILL.md · 7.3 KB · names 4 other files — download is this file only · installs the whole folder to ~/.claude/skills/find-docs

Files of Documentation Lookup

Files 1 file
Show the full text160 lines

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.

Quality Example
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
1---
2name: find-docs
3description: >-
4 Retrieves up-to-date documentation, API references, and code examples for any
5 developer technology. Use this skill whenever the user asks about a specific
6 library, framework, SDK, CLI tool, or cloud service — even for well-known ones
7 like React, Next.js, Prisma, Express, Tailwind, Django, or Spring Boot. Your
8 training data may not reflect recent API changes or version updates.
9 
10 Always use for: API syntax questions, configuration options, version migration
11 issues, "how do I" questions mentioning a library name, debugging that involves
12 library-specific behavior, setup instructions, and CLI tool usage.
13 
14 Use even when you think you know the answer — do not rely on training data
15 for API details, signatures, or configuration options as they are frequently
16 outdated. Always verify against current docs. Prefer this over web search for
17 library documentation and API details.
18---
19 
20# Documentation Lookup
21 
22Retrieve current documentation and code examples for any library using the Context7 CLI.
23 
24Run commands with `npx ctx7@latest` so setup always uses the latest CLI without a global install:
25 
26```bash
27npx ctx7@latest library <name> "<query>"
28npx ctx7@latest docs <libraryId> "<query>"
29```
30 
31Optionally install globally if you prefer a bare `ctx7` command:
32 
33```bash
34npm install -g ctx7@latest
35```
36 
37## Workflow
38 
39Two-step process: resolve the library name to an ID, then query docs with that ID.
40 
41```bash
42# Step 1: Resolve library ID
43npx ctx7@latest library <name> "<query>"
44 
45# Step 2: Query documentation
46npx ctx7@latest docs <libraryId> "<query>"
47```
48 
49You 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`.
50 
51IMPORTANT: 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.
52 
53## Step 1: Resolve a Library
54 
55Resolves a package/product name to a Context7-compatible library ID and returns matching libraries.
56 
57```bash
58npx ctx7@latest library React "How to clean up useEffect with async operations"
59npx ctx7@latest library "Next.js" "How to set up app router with middleware"
60npx ctx7@latest library Prisma "How to define one-to-many relations with cascade delete"
61```
62 
63Use 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.
64 
65Always 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.
66 
67### Result fields
68 
69Each result includes:
70 
71- **Library ID** — Context7-compatible identifier (format: `/org/project`)
72- **Name** — Library or package name
73- **Description** — Short summary
74- **Code Snippets** — Number of available code examples
75- **Source Reputation** — Authority indicator (High, Medium, Low, or Unknown)
76- **Benchmark Score** — Quality indicator (100 is the highest score)
77- **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`.
78 
79### Selection process
80 
811. Analyze the query to understand what library/package the user is looking for
822. Select the most relevant match based on:
83 - Name similarity to the query (exact matches prioritized)
84 - Description relevance to the query's intent
85 - Documentation coverage (prioritize libraries with higher Code Snippet counts)
86 - Source reputation (consider libraries with High or Medium reputation more authoritative)
87 - Benchmark score (higher is better, 100 is the maximum)
883. If multiple good matches exist, acknowledge this but proceed with the most relevant one
894. If no good matches exist, clearly state this and suggest query refinements
905. For ambiguous queries, request clarification before proceeding with a best-guess match
91 
92### Version-specific IDs
93 
94If the user mentions a specific version, use a version-specific library ID:
95 
96```bash
97# General (latest indexed)
98npx ctx7@latest docs /vercel/next.js "How to set up app router"
99 
100# Version-specific
101npx ctx7@latest docs /vercel/next.js/v14.3.0-canary.87 "How to set up app router"
102```
103 
104The available versions are listed in the `library` command output. Use the closest match to what the user specified.
105 
106## Step 2: Query Documentation
107 
108Retrieves up-to-date documentation and code examples for the resolved library.
109 
110```bash
111npx ctx7@latest docs /facebook/react "How to clean up useEffect with async operations"
112npx ctx7@latest docs /vercel/next.js "How to add authentication middleware to app router"
113npx ctx7@latest docs /prisma/prisma "How to define one-to-many relations with cascade delete"
114```
115 
116### Writing good queries
117 
118The 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.
119 
120| Quality | Example |
121|---------|---------|
122| Good | `"How to set up authentication with JWT in Express.js"` |
123| Good | `"React useEffect cleanup function with async operations"` |
124| Bad (too vague) | `"auth"` |
125| Bad (too vague) | `"hooks"` |
126| Bad (too broad) | `"routing and auth and caching in Next.js"` |
127 
128Describe 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.
129 
130The output contains two types of content: **code snippets** (titled, with language-tagged blocks) and **info snippets** (prose explanations with breadcrumb context).
131 
132## Authentication
133 
134Works without authentication. For higher rate limits:
135 
136```bash
137# Option A: environment variable
138export CONTEXT7_API_KEY=your_key
139 
140# Option B: OAuth login
141npx ctx7@latest login
142```
143 
144## Error Handling
145 
146If a command fails with a quota error ("Monthly quota reached" or "quota exceeded"):
1471. Inform the user their Context7 quota is exhausted
1482. Suggest they authenticate for higher limits: `npx ctx7@latest login`
1493. If they cannot or choose not to authenticate, answer from training knowledge and clearly note it may be outdated
150 
151Do not silently fall back to training data — always tell the user why Context7 was not used.
152 
153## Common Mistakes
154 
155- Library IDs require a `/` prefix — `/facebook/react` not `facebook/react`
156- Always run `npx ctx7@latest library` first — `npx ctx7@latest docs react "hooks"` will fail without a valid ID
157- Use descriptive queries, not single words — `"React useEffect cleanup function"` not `"hooks"`
158- 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
159- Do not include sensitive information (API keys, passwords, credentials) in queries
160 

Discussion

Alternatives

Also in Services & APIsSee all 527 in Development →
API and interface designGuides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.Coding · MITContext7Pulls up-to-date, version-specific library docs and code examples into the prompt so the AI stops inventing old APIs.Coding · MITContext7 Documentation LookupFetch up-to-date documentation and code examples for any library, framework, SDK, CLI tool, or cloud service. Use whenever the user asks about a specific library — even well-known ones like React, Next.js, Prisma, Express, Tailwind, Django, or Spring Boot — because training data may not reflect recent API changes or version updates. Always use for: API syntax questions, configuration options, version migration issues, "how do I" questions mentioning a library name, debugging that involves library-specific behavior, setup instructions, and CLI tool usage. Use even when you think you know the answer. Do not rely on training data for API details, signatures, or configuration options — they are frequently out of date. Prefer this over web search for library documentation.Coding · MITAdaptyv Bio Foundry APIHow to use the Adaptyv Bio Foundry API and Python SDK for protein experiment design, submission, and results retrieval. Use this skill whenever the user mentions Adaptyv, Foundry API, protein binding assays, protein screening experiments, BLI/SPR assays, thermostability assays, or wants to submit protein sequences for experimental characterization. Also trigger when code imports `adaptyv`, `adaptyv_sdk`, or `FoundryClient`, or references `foundry-api-public.adaptyvbio.com`.Science · MIT