Context7 Platform -- Up-to-date docs for AI agents
proofread docs
shannon rumsey009c58ff4350
diff --git a/docs/adding-libraries.mdx b/docs/adding-libraries.mdxindex 08d0b5c4..91df50ce 100644--- a/docs/adding-libraries.mdx+++ b/docs/adding-libraries.mdx@@ -18,7 +18,7 @@ You'll receive an email notification when parsing finishes. You can also monitor## Advanced Configuration with `context7.json`-For more control over how Context7 parses and presents your library, you can add a `context7.json` file to the root of your repository. This file works similar to `robots.txt` and tells Context7 how to handle your project.+For more control over how Context7 parses and presents your library, you can add a `context7.json` file to the root of your repository. This file works similarly to `robots.txt` and tells Context7 how to handle your project.### Configuration Fields@@ -65,7 +65,7 @@ Here's an example `context7.json` file with all available options:- **`previousVersions`** (array): Information about previous versions of your library that should also be available in Context7.- **`tag`**: The Git tag or version identifier-- **`branchVersions`** (array): Information about previous versions (branch based) of your library that should also+- **`branchVersions`** (array): Information about previous versions (branch-based) of your library that should alsobe available in Context7.- **`branch`**: The Git branch@@ -74,24 +74,24 @@ Here's an example `context7.json` file with all available options:The `excludeFolders` parameter supports various pattern types for flexible exclusion:- **Simple folder names**: `"node_modules"` - Excludes any folder named "node_modules" anywhere in the tree-- **Root-specific patterns**: `"./xyz"` - Excludes folder only at repository root (e.g., excludes `/xyz` but not `/dist/xyz`)+- **Root-specific patterns**: `"./xyz"` - Excludes the folder only at repository root (e.g., excludes `/xyz` but not `/dist/xyz`)- **Path patterns**: `"app-sdk/v2.3"` - Excludes specific paths and everything under them- **Glob patterns**: `"*.test"`, `"temp*"` - Excludes folders matching the pattern- **Globstar patterns**: `"**/dist"`, `"docs/**/internal"` - Advanced path matching-- **Complex patterns**: `"src/**/*.test.js"` - Exclude test files in src directory+- **Complex patterns**: `"src/**/*.test.js"` - Exclude test files in the src directoryExamples:- `"node_modules"` - Excludes all node_modules folders anywhere-- `"./build"` - Excludes build folder only at root (not `src/build`)-- `"app-sdk/v2.3"` - Excludes app-sdk/v2.3 path and all its contents+- `"./build"` - Excludes the build folder only at root (not `src/build`)+- `"app-sdk/v2.3"` - Excludes the app-sdk/v2.3 path and all its contents- `"*.test"` - Excludes folders ending with .test- `"docs/**/internal"` - Excludes any "internal" folder under docs- `"**/temp"` - Excludes any folder named "temp" anywhere### Default Exclusions-If you don't specify `excludeFiles` or `excludeFolders` in your `context7.json`, Context7 uses these default patterns:+If you don't specify `excludeFiles` or `excludeFolders` in your `context7.json` file, Context7 uses these default patterns:#### Default Excluded Files@@ -112,13 +112,13 @@ i18n/nl*, i18n/pl*, i18n/sv*, i18n/vi*, i18n/th*zh-cn, zh-tw, zh-hk, zh-mo, zh-sg```-These defaults help ensure that coding agents receive relevant, current documentation without outdated or non-technical content.+These defaults help coding agents avoid irrelevant, outdated, and non-technical content.-## Who Can Add Configuration?+## Who Can Manage Configuration?- **Library authors**: Add `context7.json` directly to your repository- **Contributors**: Submit pull requests to add or update the configuration-- **Community members**: Propose improvements to how popular libraries are parsed+- **Community members**: Propose improvements to the way popular libraries are parsed## Best Practices@@ -153,7 +153,7 @@ Keep documentation helpful for agents:- Review the rendered documentation after each release- Trim noisy sections (e.g., large changelogs) with `excludeFiles` or `excludeFolders`-- Update `rules` when best practices change so AI assistants surface current guidance+- Update `rules` when best practices change, so AI assistants surface current guidance## Need Help?diff --git a/docs/installation.mdx b/docs/installation.mdxindex f46b5bea..473c21ed 100644--- a/docs/installation.mdx+++ b/docs/installation.mdx@@ -3,7 +3,7 @@ title: InstallationsidebarTitle: Installation----Get Context7 MCP up and running in your favorite AI coding assistant in minutes.+Get the Context7 MCP up and running in your favorite AI coding assistant in minutes.## Requirements@@ -23,7 +23,7 @@ The Server-Sent Events (SSE) transport protocol has been removed and is no longe### Via Smithery-Install Context7 MCP automatically for any client via [Smithery](https://smithery.ai/server/@upstash/context7-mcp):+Install the Context7 MCP automatically for any client via [Smithery](https://smithery.ai/server/@upstash/context7-mcp):```bashnpx -y @smithery/cli@latest install @upstash/context7-mcp --client <CLIENT_NAME> --key <YOUR_SMITHERY_KEY>@@ -170,7 +170,7 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser3. Search for **Context7** in the **Marketplace** tab4. Click **Install**- Or manually edit configuration:+ Or manually edit the configuration:```json{"mcpServers": {@@ -523,7 +523,7 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser</Accordion><Accordion title="BoltAI" icon="bolt">- Open Settings → Plugins and add:+ Open Settings → Plugins, then add:```json{@@ -536,7 +536,7 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser}```- Use `get-library-docs` in chat with your Context7 documentation ID.+ Use `get-library-docs` in the chat with your Context7 documentation ID.</Accordion>@@ -587,7 +587,7 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser</Accordion><Accordion title="Qodo Gen" icon="code">- 1. Open Qodo Gen chat panel+ 1. Open the Qodo Gen chat panel2. Click **Connect more tools**3. Click **+ Add new MCP**@@ -654,7 +654,7 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser</Accordion><Accordion title="Perplexity Desktop" icon="search">- 1. Navigate `Perplexity` → `Settings` → `Connectors`+ 1. Navigate to `Perplexity` → `Settings` → `Connectors`2. Click `Add Connector` → `Advanced`3. Server Name: `Context7`4. Add configuration:@@ -670,7 +670,7 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser</Accordion><Accordion title="Warp" icon="terminal">- 1. Navigate `Settings` → `AI` → `Manage MCP servers`+ 1. Navigate to `Settings` → `AI` → `Manage MCP servers`2. Click `+ Add`3. Add configuration:@@ -689,7 +689,9 @@ Get your Smithery key from your account at [smithery.ai](https://smithery.ai/ser</Accordion><Accordion title="Copilot Coding Agent" icon="github">- Add to your Copilot configuration (Repository → Settings → Copilot → Coding agent → MCP configuration):+ Add the following to your Copilot configuration at:++ Repository → Settings → Copilot → Coding agent → MCP configuration```json{diff --git a/docs/overview.mdx b/docs/overview.mdxindex f640fed2..e5084c7f 100644--- a/docs/overview.mdx+++ b/docs/overview.mdx@@ -3,13 +3,13 @@ title: IntrosidebarTitle: Intro----Context7 brings up-to-date, version-specific documentation and code examples directly into your AI coding assistant. No more outdated examples or hallucinated APIs.+Context7 brings up-to-date, version-specific documentation and code examples directly into your AI coding assistant. That means no more outdated code or hallucinated APIs.## ❌ Without Context7LLMs rely on outdated or generic information about the libraries you use:-- ❌ Code examples are outdated and based on year-old training data+- ❌ Code examples based on old training data- ❌ Hallucinated APIs that don't even exist- ❌ Generic answers for old package versions@@ -27,7 +27,7 @@ Create a Next.js middleware that checks for a valid JWT in cookies and redirectsConfigure a Cloudflare Worker script to cache JSON API responses for five minutes. use context7```-Context7 fetches up-to-date code examples and documentation right into your LLM's context.+Context7 grounds your LLM with up-to-date documentation, ensuring that it always writes high quality code.- 1️⃣ Write your prompt naturally- 2️⃣ Add `use context7` to your promptdiff --git a/docs/usage.mdx b/docs/usage.mdxindex 73336d3a..162c8d2b 100644--- a/docs/usage.mdx+++ b/docs/usage.mdx@@ -200,7 +200,7 @@ Access your private documentation with Context7 Pro.3. Choose your source:- **Connect Repository**: Link your GitHub, GitLab, or Bitbucket account- **Upload OpenAPI Docs**: Upload your own OpenAPI documentation-4. Enter repository URL (if connecting repository)+4. Enter repository URL (if connecting a repository)5. Authorize Context7 to access your repository6. Configure folders and exclusions (optional)7. Submit@@ -227,18 +227,18 @@ Share Context7 access with your team.1. Go to **Dashboard → Members**2. Click **Invite Member**-3. Enter email and select role:+3. Enter their email and select a role:- **Owner**: Full control- **Admin**: Manage team and settings- **Developer**: API access only-Members receive an email invitation.+Members will receive an email invitation.### Manage API KeysEach team member gets their own API key with independent rate limits (60 req/hour per member).-Regenerate keys from the Members tab if compromised.+You can regenerate keys from the Members tab if compromised.Visit the [Dashboard](https://context7.com/dashboard) for team management details.@@ -285,7 +285,7 @@ Go to [Dashboard → Overview](https://context7.com/dashboard) to see:- **Query tokens**: Tokens returned in responses- **Parsing tokens**: Tokens processed when adding/refreshing-All stats show the last 30 days.+Stats reflect usage from the last 30 days.### Understand Costs@@ -308,26 +308,26 @@ Visit the [Dashboard](https://context7.com/dashboard) to monitor your usage and### Security-- Never commit API keys to version control - Use `.env` files and add them to `.gitignore`-- Use environment variables for keys - `export CONTEXT7_API_KEY=your_key_here`-- Rotate keys regularly - Rotate every 90 days or immediately if compromised-- Give team members minimum required permissions - Use "Developer" role for non-admins+- Never commit API keys to version control. Use `.env` files and add them to `.gitignore`.+- Use environment variables for keys, like: `export CONTEXT7_API_KEY=your_key_here`.+- Rotate keys regularly -- every 90 days or immediately if compromised.+- Grant only the permissions a team member needs. Use the "Developer" role for non-admins.See [Security](/security) for comprehensive security guidelines.### Performance-- Use specific library IDs when possible - `/vercel/next.js` instead of "next.js docs"-- Set appropriate token limits - small amounts for quick lookups, higher amounts for comprehensive docs-- Use topic filtering to focus results - Add specific topics like "authentication" or "routing"-- Cache frequently-used documentation locally - Cache for 6-24 hours to reduce API calls+- Use specific library IDs such as `/vercel/next.js` instead of general phrases like "next.js docs" when possible.+- Set appropriate token limits -- use lower values for quick lookups, and higher values for comprehensive docs.+- Focus results using topic filtering. Try adding specific topics like "authentication" or "routing".+- Cache frequently used documentation locally for 6-24 hours to reduce API calls.### Library Management-- Keep `context7.json` up to date in your repositories - Update when adding new docs or changing structure-- Exclude unnecessary folders (tests, build artifacts) - `excludeFolders: ["test", "dist", "node_modules"]`-- Add helpful rules for AI agents - Example: "Always validate user input" or "Use TypeScript strict mode"-- Maintain version tags for important releases - Keep v1.x docs available even after releasing v2.x+- Keep the `context7.json` file in your repositories up to date. Update it when adding new docs or changing structure.+- Exclude unnecessary folders, such as tests and build artifacts: `excludeFolders: ["test", "dist", "node_modules"]`.+- Add helpful rules for AI agents, such as "Always validate user input" or "Use TypeScript strict mode".+- Maintain version tags for important releases. For example, keep v1.x docs available even after releasing v2.x.See [Library Owners](/adding-libraries) for configuration details.