--- title: "upstash/context7" description: "Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors" source: https://github.com/upstash/context7 ref: master license: MIT licenseName: "MIT License" canonical: https://skillsdocs.com/upstash/context7 base: https://github.com/upstash/context7/blob/master/ chapters: 5 inlined: 5 withheld: 0 words: 1809 updated: 2026-08-11T16:30:19Z generator: "Skills Docs" --- > **upstash/context7** — every Agent Skill in this repository, inlined verbatim. > > Canonical HTML: https://skillsdocs.com/upstash/context7 > Per-chapter Markdown: https://skillsdocs.com/upstash/context7/.md > Machine manifest: https://skillsdocs.com/upstash/context7/.well-known/agent-skills/index.json > JSON: https://skillsdocs.com/api/v1/books/upstash/context7 > Install: `npx skills add upstash/context7` > Upstream: https://github.com/upstash/context7 @ `master` > Licence: MIT > > Content is mirrored from GitHub and © its authors, served unmodified. Takedown: https://github.com/DreambaseAI/skillsdocs/issues/new?labels=takedown&title=Takedown+request # upstash/context7 Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors - **Chapters:** 5 - **Inlined:** 5 (licence detected) - **Words:** 1,809 - **Reading time:** 9 min - **Stars:** 60,620 ## Table of contents 1. [context7-docs](https://skillsdocs.com/upstash/context7/context7-docs.md) — Fetch 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 libra… 2. [context7-mcp](https://skillsdocs.com/upstash/context7/context7-context7-mcp.md) — Fetches current, version-specific library documentation and code examples through the Context7 MCP server. Use whenever the user asks about a library, framewor… 3. [context7-cli](https://skillsdocs.com/upstash/context7/context7-cli.md) — Use the ctx7 CLI to fetch library documentation, manage AI coding skills, and configure Context7 MCP. Activate when the user mentions "ctx7" or "context7", nee… 4. [context7-mcp](https://skillsdocs.com/upstash/context7/context7-mcp.md) — This skill should be used when the user asks about libraries, frameworks, API references, or needs code examples. Activates for setup questions, code generatio… 5. [find-docs](https://skillsdocs.com/upstash/context7/find-docs.md) — Retrieves up-to-date documentation, API references, and code examples for any developer technology. Use this skill whenever the user asks about a specific libr… ## Front matter _The repository README, verbatim except that relative links are resolved against https://github.com/upstash/context7/blob/master/._ ![Cover](https://github.com/upstash/context7/blob/master/public/cover.png?raw=true) [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D) # Context7 Platform - Up-to-date Code Docs For Any Prompt [![Website](https://img.shields.io/badge/Website-context7.com-blue)](https://context7.com) [![NPM Version](https://img.shields.io/npm/v/%40upstash%2Fcontext7-mcp?color=red)](https://www.npmjs.com/package/@upstash/context7-mcp) [![MIT licensed](https://img.shields.io/npm/l/%40upstash%2Fcontext7-mcp)](./LICENSE) [![繁體中文](https://img.shields.io/badge/docs-繁體中文-yellow)](./i18n/README.zh-TW.md) [![简体中文](https://img.shields.io/badge/docs-简体中文-yellow)](./i18n/README.zh-CN.md) [![日本語](https://img.shields.io/badge/docs-日本語-b7003a)](./i18n/README.ja.md) [![한국어 문서](https://img.shields.io/badge/docs-한국어-green)](./i18n/README.ko.md) [![Documentación en Español](https://img.shields.io/badge/docs-Español-orange)](./i18n/README.es.md) [![Documentation en Français](https://img.shields.io/badge/docs-Français-blue)](./i18n/README.fr.md) [![Documentação em Português (Brasil)](https://github.com/upstash/context7/blob/master/)](./i18n/README.pt-BR.md) [![Documentazione in italiano](https://img.shields.io/badge/docs-Italian-red)](./i18n/README.it.md) [![Dokumentasi Bahasa Indonesia](https://img.shields.io/badge/docs-Bahasa%20Indonesia-pink)](./i18n/README.id-ID.md) [![Dokumentation auf Deutsch](https://img.shields.io/badge/docs-Deutsch-darkgreen)](./i18n/README.de.md) [![Документация на русском языке](https://img.shields.io/badge/docs-Русский-darkblue)](./i18n/README.ru.md) [![Українська документація](https://img.shields.io/badge/docs-Українська-lightblue)](./i18n/README.uk.md) [![Türkçe Doküman](https://img.shields.io/badge/docs-Türkçe-blue)](./i18n/README.tr.md) [![Arabic Documentation](https://img.shields.io/badge/docs-Arabic-white)](./i18n/README.ar.md) [![Tiếng Việt](https://img.shields.io/badge/docs-Tiếng%20Việt-red)](./i18n/README.vi.md) ## ❌ Without Context7 LLMs rely on outdated or generic information about the libraries you use. You get: - ❌ Code examples are outdated and based on year-old training data - ❌ Hallucinated APIs that don't even exist - ❌ Generic answers for old package versions ## ✅ With Context7 Context7 pulls up-to-date, version-specific documentation and code examples straight from the source — and places them directly into your prompt. ```txt Create a Next.js middleware that checks for a valid JWT in cookies and redirects unauthenticated users to `/login`. use context7 ``` ```txt Configure a Cloudflare Worker script to cache JSON API responses for five minutes. use context7 ``` ```txt Show me the Supabase auth API for email/password sign-up. ``` Context7 fetches up-to-date code examples and documentation right into your LLM's context. No tab-switching, no hallucinated APIs that don't exist, no outdated code generation. Works in two modes: - **CLI + Skills** — installs a skill that guides your agent to fetch docs using `ctx7` CLI commands (no MCP required) - **MCP** — registers a Context7 MCP server so your agent can call documentation tools natively ## Installation > [!NOTE] > **API Key Recommended**: Get a free API key at [context7.com/dashboard](https://context7.com/dashboard) for higher rate limits. Set up Context7 for your coding agents with a single command. The `ctx7` CLI requires Node.js 18 or newer. ```bash npx ctx7 setup ``` Authenticates via OAuth, generates an API key, and installs the appropriate skill. You can choose between CLI + Skills or MCP mode. Use `--cursor`, `--claude`, or `--opencode` to target a specific agent. To remove the generated setup later, run `npx ctx7 remove`. If you globally installed the CLI with `npm install -g ctx7`, remove that package separately with `npm uninstall -g ctx7`. To configure manually, use the Context7 server URL `https://mcp.context7.com/mcp` with your MCP client and pass your API key via the `Authorization: Bearer YOUR_API_KEY` header. See the link below for client-specific setup instructions. **[Manual Installation / Other Clients →](https://context7.com/docs/resources/all-clients)** ## Important Tips ### Use Library Id If you already know exactly which library you want to use, add its Context7 ID to your prompt. That way, Context7 can skip the library-matching step and directly retrieve docs. ```txt Implement basic authentication with Supabase. use library /supabase/supabase for API and docs. ``` The slash syntax tells Context7 exactly which library to load docs for. ### Specify a Version To get documentation for a specific library version, just mention the version in your prompt: ```txt How do I set up Next.js 14 middleware? use context7 ``` Context7 will automatically match the appropriate version. ### Add a Rule If you installed via `ctx7 setup`, a skill is configured automatically that triggers Context7 for library-related questions. To set up a rule manually instead, add one to your coding agent: - **Cursor**: `Cursor Settings > Rules` - **Claude Code**: `CLAUDE.md` - Or the equivalent in your coding agent **Example rule:** ```txt Always use Context7 when I need library/API documentation, code generation, setup or configuration steps without me having to explicitly ask. ``` ## Available Tools ### CLI Commands - `ctx7 library `: Searches the Context7 index by library name and returns matching libraries with their IDs. - `ctx7 docs `: Retrieves documentation for a library using a Context7-compatible library ID (e.g., `/mongodb/docs`, `/vercel/next.js`). ### MCP Tools - `resolve-library-id`: Resolves a general library name into a Context7-compatible library ID. - `query` (required): The user's question or task (used to rank results by relevance) - `libraryName` (required): The name of the library to search for - `query-docs`: Retrieves documentation for a library using a Context7-compatible library ID. - `libraryId` (required): Exact Context7-compatible library ID (e.g., `/mongodb/docs`, `/vercel/next.js`) - `query` (required): The question or task to get relevant documentation for ## More Documentation - [CLI Reference](https://context7.com/docs/clients/cli) - Full CLI documentation - [MCP Clients](https://context7.com/docs/resources/all-clients) - Manual MCP installation for 30+ clients - [Adding Libraries](https://context7.com/docs/adding-libraries) - Submit your library to Context7 - [Troubleshooting](https://context7.com/docs/resources/troubleshooting) - Common issues and solutions - [API Reference](https://context7.com/docs/api-guide) - REST API documentation - [Developer Guide](https://context7.com/docs/resources/developer) - Run Context7 MCP locally ## Packages - [`@upstash/context7-mcp`](https://www.npmjs.com/package/@upstash/context7-mcp) - MCP server - [`ctx7`](https://www.npmjs.com/package/ctx7) - CLI - [`@upstash/context7-sdk`](https://www.npmjs.com/package/@upstash/context7-sdk) - TypeScript SDK - [`@upstash/context7-tools-ai-sdk`](https://www.npmjs.com/package/@upstash/context7-tools-ai-sdk) - Vercel AI SDK tools - [`@upstash/context7-pi`](https://www.npmjs.com/package/@upstash/context7-pi) - pi.dev extension ## Disclaimer 1- Context7 projects are community-contributed and while we strive to maintain high quality, we cannot guarantee the accuracy, completeness, or security of all library documentation. Projects listed in Context7 are developed and maintained by their respective owners, not by Context7. If you encounter any suspicious, inappropriate, or potentially harmful content, please use the "Report" button on the project page to notify us immediately. We take all reports seriously and will review flagged content promptly to maintain the integrity and safety of our platform. By using Context7, you acknowledge that you do so at your own discretion and risk. 2- This repository hosts the MCP server’s source code. The supporting components — API backend, parsing engine, and crawling engine — are private and not part of this repository. ## 🤝 Connect with Us Stay updated and join our community: - 📢 Follow us on [X](https://x.com/context7ai) for the latest news and updates - 🌐 Visit our [Website](https://context7.com) - 💬 Join our [Discord Community](https://upstash.com/discord) ## 📺 Context7 In Media - [Better Stack: "Free Tool Makes Cursor 10x Smarter"](https://youtu.be/52FC3qObp9E) - [Cole Medin: "This is Hands Down the BEST MCP Server for AI Coding Assistants"](https://www.youtube.com/watch?v=G7gK8H6u7Rs) - [Income Stream Surfers: "Context7 + SequentialThinking MCPs: Is This AGI?"](https://www.youtube.com/watch?v=-ggvzyLpK6o) - [Julian Goldie SEO: "Context7: New MCP AI Agent Update"](https://www.youtube.com/watch?v=CTZm6fBYisc) - [JeredBlu: "Context 7 MCP: Get Documentation Instantly + VS Code Setup"](https://www.youtube.com/watch?v=-ls0D-rtET4) - [Income Stream Surfers: "Context7: The New MCP Server That Will CHANGE AI Coding"](https://www.youtube.com/watch?v=PS-2Azb-C3M) - [AICodeKing: "Context7 + Cline & RooCode: This MCP Server Makes CLINE 100X MORE EFFECTIVE!"](https://www.youtube.com/watch?v=qZfENAPMnyo) - [Sean Kochel: "5 MCP Servers For Vibe Coding Glory (Just Plug-In & Go)"](https://www.youtube.com/watch?v=LqTQi8qexJM) ## 📄 License MIT --- ## 1. context7-docs - **Source:** https://github.com/upstash/context7/blob/master/packages/pi/skills/context7-docs/SKILL.md - **Raw:** https://raw.githubusercontent.com/upstash/context7/master/packages/pi/skills/context7-docs/SKILL.md - **Markdown:** https://skillsdocs.com/upstash/context7/context7-docs.md - **Licence:** MIT — https://spdx.org/licenses/MIT.html --- name: context7-docs description: >- Fetch 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. license: MIT --- # Context7 Documentation Lookup Retrieve current documentation and code examples from [Context7](https://context7.com) using the `resolve-library-id` and `query-docs` tools that ship with this extension. ## When to use Reach for these tools whenever a question involves a specific library, framework, SDK, CLI tool, or cloud service. Examples: - "How do I configure caching in Next.js 16?" - "What's the syntax for Prisma's `findMany` with relations?" - "Show me a working Tailwind v4 install for a Vite app." - "How do I rate-limit with `@upstash/ratelimit`?" ## Workflow 1. **Resolve the library ID.** Call `resolve-library-id` with the library name and what to look up in the library's documentation. The tool returns matching libraries with their Context7 IDs (`/org/project` format), descriptions, snippet counts, and quality scores. Pick the best match — prioritize official sources, name match, and high benchmark scores. 2. **Query the docs.** Call `query-docs` with the chosen library ID and what to look up in the library's documentation, scoped to a single concept — if the question spans multiple distinct concepts, make a separate call per concept with the same library ID, unless the question is about how the concepts interact. The tool returns documentation snippets and code examples. 3. **Answer.** Cite the library ID you used and quote code examples verbatim when relevant. If the user supplies a library ID in `/org/project` or `/org/project/version` format directly, skip step 1 and call `query-docs` immediately. ## Constraints - Do not call either tool more than 3 times per question. - Do not pass API keys, passwords, credentials, personal data, or proprietary code as the `query` argument — it is sent to the Context7 API. - Authentication uses the `CONTEXT7_API_KEY` environment variable. Get a key at https://context7.com/dashboard if requests fail with an auth error. --- ## 2. context7-mcp - **Source:** https://github.com/upstash/context7/blob/master/plugins/agent-plugins/context7/skills/context7-mcp/SKILL.md - **Raw:** https://raw.githubusercontent.com/upstash/context7/master/plugins/agent-plugins/context7/skills/context7-mcp/SKILL.md - **Markdown:** https://skillsdocs.com/upstash/context7/context7-context7-mcp.md - **Licence:** MIT — https://spdx.org/licenses/MIT.html --- name: context7-mcp description: Fetches current, version-specific library documentation and code examples through the Context7 MCP server. Use whenever the user asks about a library, framework, SDK, API, CLI tool, or cloud service, including API syntax, configuration, setup instructions, version migration, CLI usage, and library-specific debugging. Use when generating code that calls a third-party library, and when the user names a version such as Next.js 15 or React 19. Use even for well-known libraries like React, Vue, Next.js, Prisma, Supabase, Express, Tailwind, Django, and Spring Boot, because training data may not reflect recent changes. Prefer this over web search for library documentation. Do not use it for refactoring, writing scripts from scratch, debugging business logic, code review, or general programming concepts, or when the user has already supplied the relevant documentation. --- When the user asks about libraries, frameworks, or needs code examples, use Context7 to fetch current documentation instead of relying on training data. ## When to Use This Skill Activate this skill when the user: - Asks setup or configuration questions ("How do I configure Next.js middleware?") - Requests code involving libraries ("Write a Prisma query for...") - Needs API references ("What are the Supabase auth methods?") - Mentions specific frameworks (React, Vue, Svelte, Express, Tailwind, etc.) ## How to Fetch Documentation ### Step 1: Resolve the Library ID Call `resolve-library-id` with: - `libraryName`: The library name extracted from the user's question - `query`: What to look up in the library's documentation (improves relevance ranking) ### Step 2: Select the Best Match From the resolution results, choose based on: - Exact or closest name match to what the user asked for - Higher benchmark scores indicate better documentation quality - If the user mentioned a version (e.g., "React 19"), prefer version-specific IDs ### Step 3: Fetch the Documentation Call `query-docs` with: - `libraryId`: The selected Context7 library ID (e.g., `/vercel/next.js`) - `query`: What to look up in the library's documentation, scoped to a single concept If the user's question spans multiple distinct concepts (e.g. routing and auth and caching), make a separate `query-docs` call per concept with the same library ID, unless the question is about how the concepts interact. Combined queries dilute ranking and return shallow results for each topic. ### Step 4: Use the Documentation Incorporate the fetched documentation into your response: - Answer the user's question using current, accurate information - Include relevant code examples from the docs - Cite the library version when relevant ## Guidelines - **Be specific**: Describe what to look up in the library's documentation, but keep each query to a single concept - **One topic per query**: Split multi-topic questions into separate `query-docs` calls. Resolve the library ID once, then query per concept, unless the question is about how the concepts interact - **Version awareness**: When users mention versions ("Next.js 15", "React 19"), use version-specific library IDs if available from the resolution step - **Prefer official sources**: When multiple matches exist, prefer official/primary packages over community forks --- ## 3. context7-cli - **Source:** https://github.com/upstash/context7/blob/master/skills/context7-cli/SKILL.md - **Raw:** https://raw.githubusercontent.com/upstash/context7/master/skills/context7-cli/SKILL.md - **Markdown:** https://skillsdocs.com/upstash/context7/context7-cli.md - **Licence:** MIT — https://spdx.org/licenses/MIT.html Bundled files (3), referenced from this skill's directory: - `references/docs.md` — https://raw.githubusercontent.com/upstash/context7/master/skills/context7-cli/references/docs.md - `references/setup.md` — https://raw.githubusercontent.com/upstash/context7/master/skills/context7-cli/references/setup.md - `references/skills.md` — https://raw.githubusercontent.com/upstash/context7/master/skills/context7-cli/references/skills.md --- name: context7-cli description: Use the ctx7 CLI to fetch library documentation, manage AI coding skills, and configure Context7 MCP. Activate when the user mentions "ctx7" or "context7", needs current docs for any library, wants to install/search/generate skills, or needs to set up Context7 for their AI coding agent. --- # ctx7 CLI The Context7 CLI does three things: fetches up-to-date library documentation, manages AI coding skills, and sets up Context7 MCP for your editor. Make sure the CLI is up to date before running commands: ```bash npm install -g ctx7@latest ``` Or run directly without installing: ```bash npx ctx7@latest ``` ## What this skill covers - **[Documentation](references/docs.md)** — Fetch current docs for any library. Use when writing code, verifying API signatures, or when training data may be outdated. - **[Skills management](references/skills.md)** — Install, search, suggest, list, remove, and generate AI coding skills. - **[Setup](references/setup.md)** — Configure Context7 MCP for Claude Code / Cursor / OpenCode. ## Quick Reference ```bash # Documentation ctx7 library # Step 1: resolve library ID ctx7 docs # Step 2: fetch docs # Skills ctx7 skills install /owner/repo # Install from a repo (interactive) ctx7 skills install /owner/repo name # Install a specific skill ctx7 skills search # Search the registry ctx7 skills suggest # Auto-suggest based on project deps ctx7 skills list # List installed skills ctx7 skills remove # Uninstall a skill ctx7 skills generate # Generate a custom skill with AI (requires login) # Setup ctx7 setup # Configure Context7 MCP (interactive) ctx7 login # Log in for higher rate limits + skill generation ctx7 whoami # Check current login status ``` ## Authentication ```bash ctx7 login # Opens browser for OAuth ctx7 login --no-browser # Prints URL instead of opening browser ctx7 logout # Clear stored tokens ctx7 whoami # Show current login status (name + email) ``` Most commands work without login. Exceptions: `skills generate` always requires it; `ctx7 setup` requires it unless `--api-key` or `--oauth` is passed. Login also unlocks higher rate limits on docs commands. Set an API key via environment variable to skip interactive login entirely: ```bash export CONTEXT7_API_KEY=your_key ``` ## Common Mistakes - Library IDs require a `/` prefix — `/facebook/react` not `facebook/react` - Always run `ctx7 library` first — `ctx7 docs react "hooks"` will fail without a valid ID - Repository format for skills is `/owner/repo` — e.g., `ctx7 skills install /anthropics/skills` - `skills generate` requires login — run `ctx7 login` first --- ## 4. context7-mcp - **Source:** https://github.com/upstash/context7/blob/master/skills/context7-mcp/SKILL.md - **Raw:** https://raw.githubusercontent.com/upstash/context7/master/skills/context7-mcp/SKILL.md - **Markdown:** https://skillsdocs.com/upstash/context7/context7-mcp.md - **Licence:** MIT — https://spdx.org/licenses/MIT.html --- name: context7-mcp description: This skill should be used when the user asks about libraries, frameworks, API references, or needs code examples. Activates for setup questions, code generation involving libraries, or mentions of specific frameworks like React, Vue, Next.js, Prisma, Supabase, etc. --- When the user asks about libraries, frameworks, or needs code examples, use Context7 to fetch current documentation instead of relying on training data. ## When to Use This Skill Activate this skill when the user: - Asks setup or configuration questions ("How do I configure Next.js middleware?") - Requests code involving libraries ("Write a Prisma query for...") - Needs API references ("What are the Supabase auth methods?") - Mentions specific frameworks (React, Vue, Svelte, Express, Tailwind, etc.) ## How to Fetch Documentation ### Step 1: Resolve the Library ID Call `resolve-library-id` with: - `libraryName`: The library name extracted from the user's question - `query`: What to look up in the library's documentation (improves relevance ranking) ### Step 2: Select the Best Match From the resolution results, choose based on: - Exact or closest name match to what the user asked for - Higher benchmark scores indicate better documentation quality - If the user mentioned a version (e.g., "React 19"), prefer version-specific IDs ### Step 3: Fetch the Documentation Call `query-docs` with: - `libraryId`: The selected Context7 library ID (e.g., `/vercel/next.js`) - `query`: What to look up in the library's documentation, scoped to a single concept If the user's question spans multiple distinct concepts (e.g. routing and auth and caching), make a separate `query-docs` call per concept with the same library ID, unless the question is about how the concepts interact — combined queries dilute ranking and return shallow results for each topic. ### Step 4: Use the Documentation Incorporate the fetched documentation into your response: - Answer the user's question using current, accurate information - Include relevant code examples from the docs - Cite the library version when relevant ## Guidelines - **Be specific**: Describe what to look up in the library's documentation, but keep each query to a single concept - **One topic per query**: Split multi-topic questions into separate `query-docs` calls — resolve the library ID once, then query per concept, unless the question is about how the concepts interact - **Version awareness**: When users mention versions ("Next.js 15", "React 19"), use version-specific library IDs if available from the resolution step - **Prefer official sources**: When multiple matches exist, prefer official/primary packages over community forks --- ## 5. find-docs - **Source:** https://github.com/upstash/context7/blob/master/skills/find-docs/SKILL.md - **Raw:** https://raw.githubusercontent.com/upstash/context7/master/skills/find-docs/SKILL.md - **Markdown:** https://skillsdocs.com/upstash/context7/find-docs.md - **Licence:** MIT — https://spdx.org/licenses/MIT.html --- name: find-docs description: >- Retrieves up-to-date documentation, API references, and code examples for any developer technology. Use this skill whenever the user asks about a specific library, framework, SDK, CLI tool, or cloud service — even for well-known ones like React, Next.js, Prisma, Express, Tailwind, Django, or Spring Boot. Your 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 as they are frequently outdated. Always verify against current docs. Prefer this over web search for library documentation and API details. --- # 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: ```bash npx ctx7@latest library "" npx ctx7@latest docs "" ``` Optionally install globally if you prefer a bare `ctx7` command: ```bash npm install -g ctx7@latest ``` ## Workflow Two-step process: resolve the library name to an ID, then query docs with that ID. ```bash # Step 1: Resolve library ID npx ctx7@latest library "" # Step 2: Query documentation npx ctx7@latest docs "" ``` 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. ```bash 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: ```bash # 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. ```bash 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: ```bash # 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