Skip to content

Context7 Platform -- Up-to-date docs for AI agents

update docs

enesakar5378233d9edd
diff --git a/docs/library-owners.mdx b/docs/adding-libraries.mdx
similarity index 100%
rename from docs/library-owners.mdx
rename to docs/adding-libraries.mdx
diff --git a/docs/adding-projects.md b/docs/adding-projects.md
deleted file mode 100644
index 65b13cee..00000000
--- a/docs/adding-projects.md
+++ /dev/null
@@ -1,153 +0,0 @@
-# Adding Projects to Context7
-
-Context7 allows you to add your favorite libraries and frameworks to help developers get up-to-date documentation directly in their coding environment.
-
-## Quick Submission
-
-The easiest way to add a library is through our web interface:
-
-**[Submit a Library β†’](https://context7.com/add-library?tab=github)**
-
-Simply provide the GitHub repository URL and Context7 will automatically parse and index the project's documentation.
-
-## 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.
-
-### Configuration Fields
-
-Here's an example `context7.json` file with all available options:
-
-```json
-{
- "$schema": "https://context7.com/schema/context7.json",
- "projectTitle": "Upstash Ratelimit",
- "description": "Ratelimiting library based on Upstash Redis",
- "folders": [],
- "excludeFolders": ["src"],
- "excludeFiles": [],
- "rules": ["Use Upstash Redis as a database", "Use single region set up"],
- "previousVersions": [
- {
- "tag": "v1.2.1",
- "title": "version 1.2.1"
- }
- ]
-}
-```
-
-> **πŸ’‘ Pro Tip**: Including the `$schema` field enables autocomplete, validation, and helpful tooltips in modern code editors like VS Code, making it easier to create and maintain your configuration.
-
-## Field Descriptions
-
-- **`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM
- can not generate a name with high confidence.
-
-- **`description`** (string): Suggested description for your project in Context7. Only used when LLM can
- not generate a name with high confidence.
-
-- **`branch`** (string): The name of the git branch to parse. If not provided, the default branch will
- be used.
-
-- **`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7
- will scan the entire repository for relevant documentation files. Note: Root-level markdown files are
- always included regardless of this setting.
-
-- **`excludeFolders`** (array): Patterns to exclude folders and paths from documentation parsing.
- Supports simple names, paths, and glob patterns (see Exclusion Patterns section below).
-
-- **`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include
- the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other
- non-documentation content.
-
-- **`rules`** (array): Best practices or important guidelines that coding agents should follow when
- using your library. These appear as recommendations in the documentation context provided to coding
- agents.
-
-- **`previousVersions`** (array): Information about previous versions of your library that should also
- be available in Context7.
- - **`tag`**: The Git tag or version identifier
- - **`title`**: Human-readable version name
-
-### Exclusion Patterns
-
-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`)
-- **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
-
-Examples:
-
-- `"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
-- `"*.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:
-
-#### Default Excluded Files
-
-```
-CHANGELOG.md, changelog.md, CHANGELOG.mdx, changelog.mdx
-LICENSE.md, license.md
-CODE_OF_CONDUCT.md, code_of_conduct.md
-```
-
-#### Default Excluded Folders
-
-```
-*archive*, *archived*, old, docs/old, *deprecated*, *legacy*
-*previous*, *outdated*, *superseded*
-i18n/zh*, i18n/es*, i18n/fr*, i18n/de*, i18n/ja*, i18n/ko*
-i18n/ru*, i18n/pt*, i18n/it*, i18n/ar*, i18n/hi*, i18n/tr*
-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.
-
-## Who Can Add 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
-
-## Best Practices
-
-1. **Keep descriptions concise**: Aim for one clear sentence that explains your library's purpose to coding agents
-2. **Exclude irrelevant folders**: Use `excludeFolders` to avoid indexing source code, tests, or build artifacts
-3. **Add helpful rules**: Include common gotchas or best practices that coding agents should know when generating code
-4. **Maintain version history**: Keep important previous versions accessible for projects that need older APIs
-
-## Adding a Version
-
-To add a new version to your existing library:
-
-1. **Add version to the `context7.json` file**: Update the `previousVersions` array with your new version:
-
- ```json
- "previousVersions": [
- {
- "tag": "v2.0.0",
- "title": "version 2.0.0"
- }
- ]
- ```
-
- > **Note**: The `tag` value must exactly match an existing Git tag in your GitHub repository.
-
-2. **Refresh your library**: Go to your library page on Context7 and trigger a refresh to index the new version.
-
-## Need Help?
-
-If you encounter issues or need assistance adding your project, please [report an issue](https://context7.com/add-library?tab=github) or reach out to our community.
diff --git a/docs/contact.mdx b/docs/contact.mdx
new file mode 100644
index 00000000..9c2c8347
--- /dev/null
+++ b/docs/contact.mdx
@@ -0,0 +1,354 @@
+---
+title: Troubleshooting
+---
+
+This guide helps you resolve common issues when setting up or using Context7 MCP.
+
+## Quick Checklist
+
+- Confirm Node.js v18+ is installed (`node --version`)
+- Update to the latest Context7 MCP package (`@upstash/context7-mcp@latest`)
+- Verify connectivity with `curl https://mcp.context7.com/mcp/ping`
+- Add your API key to the configuration if you hit rate limits
+- Enable debug logs (`DEBUG=*`) before collecting support information
+
+## Installation Issues
+
+### Module Not Found Errors
+
+If you encounter `ERR_MODULE_NOT_FOUND`, try using `bunx` instead of `npx`:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "bunx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+This often resolves module resolution issues in environments where `npx` doesn't properly install or resolve packages.
+
+### ESM Resolution Issues
+
+For errors like `Error: Cannot find module 'uriTemplate.js'`, try the `--experimental-vm-modules` flag:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "--node-options=--experimental-vm-modules", "@upstash/[email protected]"]
+ }
+ }
+}
+```
+
+### TLS/Certificate Issues
+
+Use the `--experimental-fetch` flag to bypass TLS-related problems:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "--node-options=--experimental-fetch", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+## General Solutions
+
+### Quick Fixes
+
+1. **Try adding `@latest`** to the package name to ensure you're using the most recent version:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp@latest", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+}
+```
+
+2. **Use `bunx` as an alternative** to `npx`:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "bunx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+}
+```
+
+3. **Consider using `deno`** as another alternative runtime:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "deno",
+ "args": [
+ "run",
+ "--allow-env=NO_DEPRECATION,TRACE_DEPRECATION",
+ "--allow-net",
+ "npm:@upstash/context7-mcp"
+ ]
+ }
+ }
+}
+```
+
+4. **Ensure you're using Node.js v18 or higher** for native fetch support:
+
+```bash
+node --version
+```
+
+If you're on an older version, upgrade Node.js to v18 or later.
+
+## Platform-Specific Issues
+
+### Windows Issues
+
+#### Request Timeout Errors
+
+On Windows, some users may encounter request timeout errors with the default configuration. Try using the full path to Node.js and the installed package:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "C:\\Program Files\\nodejs\\node.exe",
+ "args": [
+ "C:\\Users\\yourname\\AppData\\Roaming\\npm\\node_modules\\@upstash\\context7-mcp\\dist\\index.js",
+ "--transport",
+ "stdio",
+ "--api-key",
+ "YOUR_API_KEY"
+ ]
+ }
+ }
+}
+```
+
+Alternatively, use this configuration with `cmd`:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "cmd",
+ "args": [
+ "/c",
+ "npx",
+ "-y",
+ "@upstash/context7-mcp",
+ "--api-key",
+ "YOUR_API_KEY"
+ ]
+ }
+ }
+}
+```
+
+### macOS Issues
+
+#### Request Timeout Errors
+
+On macOS, some users may encounter the same request timeout errors. Use the full path to Node.js and the installed package:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "/Users/yourname/.nvm/versions/node/v22.14.0/bin/node",
+ "args": [
+ "/Users/yourname/.nvm/versions/node/v22.14.0/lib/node_modules/@upstash/context7-mcp/dist/index.js",
+ "--transport",
+ "stdio",
+ "--api-key",
+ "YOUR_API_KEY"
+ ]
+ }
+ }
+}
+```
+
+<Note>
+Replace `yourname` and the Node.js version (`v22.14.0`) with your actual username and installed Node.js version.
+</Note>
+
+## API and Connection Issues
+
+### Rate Limiting
+
+If you encounter rate limit errors:
+
+- **Get an API key**: Sign up at [context7.com/dashboard](https://context7.com/dashboard) for higher rate limits
+- **Add API key to your configuration**:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+}
+```
+
+### Authentication Errors
+
+If you see `401 Unauthorized` errors:
+
+1. **Verify your API key** is correct and starts with `ctx7sk`
+2. **Check the header format** - ensure the API key is properly set:
+
+For HTTP transport:
+```json
+{
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+}
+```
+
+For stdio transport:
+```json
+{
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+}
+```
+
+### Library Not Found
+
+If you get `404 Not Found` errors:
+
+1. **Verify the library ID** format is correct: `/owner/repo` or `/owner/repo/version`
+2. **Search for the library** first using `resolve-library-id` tool
+3. **Check if the library exists** at [context7.com](https://context7.com)
+
+## MCP Client-Specific Issues
+
+### Cursor
+
+- Make sure you're using Cursor 1.0 or later for best MCP support
+- Try both global (`~/.cursor/mcp.json`) and project-specific (`.cursor/mcp.json`) configurations
+- Restart Cursor after changing MCP configuration
+
+### VS Code
+
+- Ensure you have the latest version of VS Code with MCP support
+- Check that the Copilot extension is installed and updated
+- Restart VS Code after configuration changes
+
+### Claude Code
+
+- Verify the MCP server is added correctly with `claude mcp list`
+- Check logs with `claude mcp logs context7`
+- Try removing and re-adding the server
+
+## Proxy Issues
+
+If you're behind a corporate proxy:
+
+1. **Set environment variables** before starting your MCP client:
+
+```bash
+export https_proxy=http://proxy.example.com:8080
+export HTTPS_PROXY=http://proxy.example.com:8080
+```
+
+2. **Or add to your MCP configuration**:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "env": {
+ "https_proxy": "http://proxy.example.com:8080",
+ "HTTPS_PROXY": "http://proxy.example.com:8080"
+ }
+ }
+ }
+}
+```
+
+See [How To - Using HTTPS Proxy](/how-to#using-https-proxy) for more details.
+
+## Debugging Tips
+
+### Enable Verbose Logging
+
+Add debug output to your configuration:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "env": {
+ "DEBUG": "*"
+ }
+ }
+ }
+}
+```
+
+### Test with MCP Inspector
+
+Test your setup independently:
+
+```bash
+npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp
+```
+
+This opens an interactive inspector to test Context7 tools.
+
+### Check Server Status
+
+Test the remote server is reachable:
+
+```bash
+curl https://mcp.context7.com/mcp/ping
+```
+
+Should return: `{"status": "ok", "message": "pong"}`
+
+## Still Having Issues?
+
+If none of these solutions work:
+
+1. **Check GitHub Issues**: Search for similar problems at [github.com/upstash/context7/issues](https://github.com/upstash/context7/issues)
+2. **Create a new issue**: Include your:
+ - Operating system and version
+ - Node.js version (`node --version`)
+ - MCP client and version
+ - Configuration (remove sensitive data like API keys)
+ - Error messages and logs
+3. **Join Discord**: Get help from the community at [upstash.com/discord](https://upstash.com/discord)
+
+## Additional Resources
+
+- [Getting Started Guide](/getting-started)
+- [Installation Instructions](/getting-started#installation)
+- [MCP Documentation](/mcp)
+- [API Documentation](/api)
+- [Security & Privacy](/security)
diff --git a/docs/dashboard.mdx b/docs/dashboard.mdx
deleted file mode 100644
index 40f8c4d1..00000000
--- a/docs/dashboard.mdx
+++ /dev/null
@@ -1,362 +0,0 @@
----
-title: Dashboard
----
-
-Your central hub for managing documentation access, team collaboration, and usage monitoring.
-
-Access your dashboard at [context7.com/dashboard](https://context7.com/dashboard)
-
-## Quick Actions
-
-- Copy your API key or regenerate it from **Overview β†’ API Connection**
-- Monitor rate limits and token usage in **Overview β†’ Usage Statistics**
-- Control access to libraries and repositories in **Libraries**
-- Invite teammates and manage roles in **Members**
-- Upgrade your plan or manage billing directly from the Dashboard sidebar
-
-## Dashboard Overview
-
-The dashboard has three main tabs for managing different aspects of your project.
-
-### Overview Tab
-
-Your project's command center.
-
-**Usage Statistics**:
-View your last 30 days of activity:
-- **Search requests**: How many library searches you've performed
-- **Query/fetch requests**: Documentation retrieval count
-- **Query tokens**: Total tokens returned in responses
-- **Parsing tokens**: Tokens used when adding/refreshing libraries
-
-**API Connection**:
-- Copy your API key (starts with `ctx7sk`)
-- View rate limits for your current plan
-- See example configurations for MCP and REST API
-
-**Project Settings**:
-- Rename your project
-- Delete team projects (if no private repos exist)
-- View project metadata
-
-### Libraries Tab
-
-Control which libraries your project can access.
-
-**Public Library Access**:
-
-Choose your access level:
-- **All Libraries** (default): Access all public documentation
-- **Select Libraries**: Whitelist specific libraries only
-- **Disabled**: Block all public library access
-
-**Token Limits**:
-Set maximum tokens per API request (default: 10,000). Lower limits = faster responses and lower costs for large libraries.
-
-**Private Repositories** (Pro/Team only):
-- Add private GitHub/GitLab repositories
-- View all private repos with access
-- Remove private repositories
-- See parsing status and token count
-
-### Members Tab
-
-Manage your team and API access (Team projects only).
-
-**Team Members**:
-- View all members and their roles
-- Invite new members via email
-- Update member roles (Owner, Admin, Developer)
-- Remove team members
-- View pending invitations
-
-**API Keys**:
-Each member gets their own API key with 60 req/hour. Regenerate keys for security.
-
-**Billing Estimate**:
-View your monthly costs:
-- Member seats: $7/month each
-- Parse tokens: $15 per 1M tokens
-
-## Personal vs Team Projects
-
-| Feature | Personal Project | Team Project |
-|---------|------------------|--------------|
-| Members | You only | Up to 20 |
-| Private repos | ❌ | βœ… |
-| Billing | Free | Usage-based |
-| Can delete | No | Yes* |
-| Rate limits | 60 req/hr | 60 req/hr per member |
-
-*Team projects can only be deleted if they have no private repositories.
-
-### Personal Projects
-
-Every user gets one personal project automatically:
-- Always free
-- Access to all public libraries
-- Cannot be deleted
-- Single user access
-- Perfect for individual development
-
-### Team Projects
-
-Create up to 5 team projects for collaboration:
-- Invite team members
-- Add private repositories
-- Role-based access control
-- Usage-based billing
-- Shared API access
-
-## Getting Your API Key
-
-1. Go to **Dashboard β†’ Overview**
-2. Find the **API Connection** section
-3. Click to copy your API key
-4. Keep it secure - treat it like a password
-
-### Using Your API Key
-
-**MCP Server**:
-```json
-{
- "mcpServers": {
- "context7": {
- "url": "https://mcp.context7.com/mcp",
- "headers": {
- "CONTEXT7_API_KEY": "YOUR_API_KEY"
- }
- }
- }
-}
-```
-
-**REST API**:
-```bash
-curl "https://context7.com/api/v1/vercel/next.js" \
- -H "Authorization: Bearer YOUR_API_KEY"
-```
-
-## Managing Libraries
-
-### Adding Public Libraries
-
-Public libraries are submitted through the web interface, not the dashboard.
-
-1. Go to [context7.com/add-library](https://context7.com/add-library)
-2. Enter repository URL
-3. Configure parsing options
-4. Submit for processing
-
-See [Library Owners](/library-owners) for detailed configuration.
-
-### Adding Private Repositories
-
-<Note>
-Requires Pro or Team plan. See [Plans & Pricing](/plans-pricing).
-</Note>
-
-1. Navigate to **Dashboard β†’ Libraries β†’ Private Repositories**
-2. Click **Add Private Repository**
-3. Enter repository URL
-4. Provide access token:
- - GitHub: Personal Access Token with `repo` scope
- - GitLab: Personal Access Token with `read_repository` scope
-5. Configure folders and exclusions (optional)
-6. Submit
-
-**Cost**: $15 per 1M tokens parsed (one-time when adding, incremental when refreshing).
-
-### Refreshing Libraries
-
-Update library documentation:
-
-1. Visit [context7.com/refresh-library](https://context7.com/refresh-library)
-2. Enter library ID (e.g., `/vercel/next.js`)
-3. Submit
-
-Private repos: You only pay for new/changed content.
-
-## Team Collaboration
-
-### Creating a Team Project
-
-1. Click **Create Team Project** in the dashboard
-2. Enter project name
-3. You're automatically set as Owner
-
-### Inviting Team Members
-
-1. Go to **Dashboard β†’ Members**
-2. Click **Invite Member**
-3. Enter email address
-4. Select role:
- - **Owner**: Full control, billing access, cannot be removed
- - **Admin**: Manage members, libraries, and settings
- - **Developer**: API access and documentation viewing only
-5. Send invitation
-
-Members receive an email invite to join.
-
-### Managing Roles
-
-Change member roles from the Members tab. Only Owners can modify other Owners.
-
-### Removing Members
-
-1. Go to **Dashboard β†’ Members**
-2. Click remove icon next to member
-3. Confirm removal
-
-Their API key is immediately revoked.
-
-## Usage Monitoring
-
-### Understanding Metrics
-
-**Search Requests**:
-Times you searched for libraries via API (`/v1/search` endpoint).
-
-**Query/Fetch Requests**:
-Times you retrieved documentation (`/v1/{owner}/{repo}` endpoint).
-
-**Query Tokens**:
-Total tokens returned in API responses. Doesn't affect billing directly.
-
-**Parsing Tokens**:
-Tokens processed when adding or refreshing private repositories. **This is what you're billed for** on Pro plans.
-
-### Cost Calculation
-
-**Free Plan**: $0 (always)
-
-**Pro Plan**:
-- Base: $7/month per team member
-- Plus: $15 per 1M parsing tokens (private repos only)
-
-**Example**:
-- 3 team members = $21/month
-- Added 750K token private repo = $11.25 one-time
-- Refreshed with 50K new content = $0.75
-- Monthly total = $21 + usage
-
-See [Plans & Pricing](/plans-pricing) for detailed pricing.
-
-### Viewing Logs
-
-Check parsing status and errors:
-
-1. Visit any library page (e.g., `context7.com/upstash/docs`)
-2. Click **View Logs**
-3. See real-time parsing progress and any errors
-
-## Security Best Practices
-
-### API Key Security
-
-- ❌ Never commit to version control
-- βœ… Use environment variables
-- βœ… Rotate keys regularly
-- βœ… Revoke compromised keys immediately
-- βœ… Use separate keys for different environments
-
-### Access Management
-
-- Give team members minimum required role
-- Review team members regularly
-- Remove members who no longer need access
-- Monitor usage for unusual patterns
-
-### Private Repository Security
-
-- Use tokens with minimum required scopes
-- Rotate repository tokens periodically
-- Remove unused private repositories
-- Audit access regularly
-
-See [Security](/security) for comprehensive guidelines.
-
-## Billing and Payments
-
-### Adding Payment Method
-
-1. Click **Add Payment Method** in Dashboard
-2. Enter card details via Stripe
-3. Submit securely
-
-Your card is charged monthly for team seats and parsing usage.
-
-### Viewing Invoices
-
-Invoices are emailed monthly and include:
-- Member seat charges
-- Parse token usage
-- Total amount
-
-Download from your email or request from support.
-
-### Downgrading
-
-To downgrade from Pro to Free:
-
-1. Remove all team members except yourself
-2. Delete all private repositories
-3. Visit [Plans & Pricing](https://context7.com/plans)
-4. Click **Choose Free Plan**
-
-<Warning>
-Downgrading removes team collaboration and private repository access.
-</Warning>
-
-## Troubleshooting
-
-### Common Issues
-
-**"Not authorized to access this project"**
-- Verify you're logged in with the correct account
-- Check you're a member of the project
-- Ask the project owner to invite you
-
-**"Rate limit exceeded"**
-- Wait for your hourly limit to reset (60 req/hr)
-- Pro plan: Each team member gets their own 60 req/hr
-- Enterprise: Contact us for custom limits
-
-**"Private repository access denied"**
-- Verify your access token is valid and not expired
-- Check token has required scopes (`repo` for GitHub)
-- Ensure you're on a Pro or Team plan
-
-**"Library not found"**
-- Verify the library ID format (`/owner/repo`)
-- Check the library exists at [context7.com](https://context7.com)
-- Try searching for it first
-
-See [Troubleshooting](/troubleshooting) for more solutions.
-
-## Next Steps
-
-<CardGroup cols={2}>
- <Card title="Learn Best Practices" icon="lightbulb" href="/how-to">
- Practical guides for optimizing your Context7 usage
- </Card>
-
- <Card title="Add Your Library" icon="plus" href="/library-owners">
- Submit your library to Context7
- </Card>
-
- <Card title="View API Docs" icon="code" href="/api">
- Complete REST API reference
- </Card>
-
- <Card title="Upgrade Plan" icon="arrow-up" href="/plans-pricing">
- Unlock team features and private repos
- </Card>
-</CardGroup>
-
-## Support
-
-- **Documentation**: Browse all docs at [docs.context7.com](https://docs.context7.com)
-- **GitHub**: Report issues at [github.com/upstash/context7](https://github.com/upstash/context7/issues)
-- **Discord**: Join [upstash.com/discord](https://upstash.com/discord)
-- **Email**: Pro and Enterprise customers can email support
diff --git a/docs/docs.json b/docs/docs.json
index ee57ffa3..21264ce1 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -10,15 +10,14 @@
},
"navigation": {
"pages": [
- "getting-started",
- "dashboard",
+ "overview",
+ "installation",
+ "usage",
+ "adding-libraries",
"plans-pricing",
- "how-to",
- "library-owners",
"api",
- "mcp",
"security",
- "troubleshooting"
+ "contact"
]
},
"logo": {
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
deleted file mode 100644
index 5033012e..00000000
--- a/docs/getting-started.mdx
+++ /dev/null
@@ -1,210 +0,0 @@
----
-title: Getting Started with Context7
-sidebarTitle: Getting Started
----
-
-Context7 brings up-to-date, version-specific documentation and code examples directly into your AI coding assistant. No more outdated examples or hallucinated APIs.
-
-## Why Context7?
-
-**The Problem:**
-- LLMs use outdated training data from months or years ago
-- Hallucinated APIs that don't actually exist
-- Generic answers that don't match your library version
-
-**The Solution:**
-Context7 fetches current documentation in real-time, so your AI assistant always has the latest information.
-
-## Quick Example
-
-Instead of hoping your AI knows the latest API:
-
-```txt
-Create a Next.js middleware that checks for a valid JWT in cookies. use context7
-```
-
-Context7 automatically pulls the current Next.js documentation into the AI's context.
-
-## Three Steps to Get Started
-
-### Before You Begin
-
-- Sign up or log in at [context7.com](https://context7.com) to access the dashboard
-- (Optional) Generate an API key for higher rate limits
-- Confirm your MCP client (Cursor, Claude Code, Windsurf, etc.) is on the latest version
-- Ensure Node.js v18+ is installed if you plan to run the local MCP server
-
-### 1. Install Context7 MCP
-
-Choose your preferred client below for installation instructions.
-
-<AccordionGroup>
- <Accordion title="Cursor" icon="cursor">
- **One-Click Install** (Cursor 1.0+):
-
- Click β†’ `Settings` β†’ `Cursor Settings` β†’ `MCP` β†’ `Add new global MCP server`
-
- **Remote Server (Recommended)**:
- ```json
- {
- "mcpServers": {
- "context7": {
- "url": "https://mcp.context7.com/mcp",
- "headers": {
- "CONTEXT7_API_KEY": "YOUR_API_KEY"
- }
- }
- }
- }
- ```
-
- Or add to `~/.cursor/mcp.json` manually.
- </Accordion>
-
- <Accordion title="Claude Code" icon="code">
- **Remote Server**:
- ```bash
- claude mcp add --transport http context7 https://mcp.context7.com/mcp \
- --header "CONTEXT7_API_KEY: YOUR_API_KEY"
- ```
-
- **Local Server**:
- ```bash
- claude mcp add context7 -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY
- ```
- </Accordion>
-
- <Accordion title="VS Code" icon="code">
- Add to your VS Code MCP config:
-
- ```json
- "mcp": {
- "servers": {
- "context7": {
- "type": "http",
- "url": "https://mcp.context7.com/mcp",
- "headers": {
- "CONTEXT7_API_KEY": "YOUR_API_KEY"
- }
- }
- }
- }
- ```
- </Accordion>
-
- <Accordion title="Windsurf" icon="wind">
- ```json
- {
- "mcpServers": {
- "context7": {
- "serverUrl": "https://mcp.context7.com/mcp",
- "headers": {
- "CONTEXT7_API_KEY": "YOUR_API_KEY"
- }
- }
- }
- }
- ```
- </Accordion>
-
- <Accordion title="Other Clients" icon="ellipsis">
- Context7 supports 25+ MCP clients including:
- - Zed, Cline, Amp
- - JetBrains AI Assistant
- - OpenAI Codex, Gemini CLI
- - LM Studio, Perplexity
- - And many more...
-
- See the [README](https://github.com/upstash/context7) for detailed instructions.
- </Accordion>
-</AccordionGroup>
-
-<Note>
-**API Key**: Get yours at [context7.com/dashboard](https://context7.com/dashboard) for higher rate limits. Works without a key for basic usage.
-</Note>
-
-### 2. Try It Out
-
-Add `use context7` to any coding prompt:
-
-```txt
-Build a Redis rate limiter with sliding window. use context7
-```
-
-```txt
-Set up Supabase auth with Next.js middleware. use context7
-```
-
-Context7 automatically finds and retrieves the relevant documentation.
-
-### 3. Optimize Your Workflow
-
-**Auto-invoke Context7** by adding a rule to your AI:
-
-<Tabs>
- <Tab title="Cursor">
- Go to `Cursor Settings` β†’ `Rules` and add:
- ```txt
- Always use context7 for code generation and library documentation.
- ```
- </Tab>
- <Tab title="Windsurf">
- Add to `.windsurfrules` in your project:
- ```txt
- Use context7 for all code and API questions.
- ```
- </Tab>
- <Tab title="Claude Code">
- Add to `CLAUDE.md` in your project:
- ```txt
- Use context7 when generating code or explaining APIs.
- ```
- </Tab>
-</Tabs>
-
-Now you don't need to type "use context7" every time!
-
-## How It Works
-
-1. **You prompt your AI** with a coding question
-2. **Context7 MCP intercepts** library names from your prompt
-3. **Documentation is fetched** in real-time from Context7's database
-4. **AI responds** with current, accurate information
-
-All happening seamlessly in the background.
-
-## Requirements
-
-- **Node.js**: v18.0.0 or higher
-- **MCP Client**: Cursor, Claude Code, VS Code, or another MCP-supported IDE
-- **API Key**: Optional, but recommended for higher rate limits
-
-<Tip>
-Not sure everything is wired up? Run `npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp` to validate the connection before you jump back into coding.
-</Tip>
-
-## What's Next?
-
-<CardGroup cols={2}>
- <Card title="Explore the Dashboard" icon="gauge" href="/dashboard">
- Manage your API keys, monitor usage, and set up team collaboration
- </Card>
-
- <Card title="View Pricing" icon="tag" href="/plans-pricing">
- Free for public repos, Pro for teams and private repositories
- </Card>
-
- <Card title="Add Your Library" icon="plus" href="/library-owners">
- Submit your own library to make it available in Context7
- </Card>
-
- <Card title="How-To Guides" icon="book" href="/how-to">
- Learn advanced techniques and best practices
- </Card>
-</CardGroup>
-
-## Troubleshooting
-
-Having issues? Check our [Troubleshooting Guide](/troubleshooting) for common solutions.
-
-Need help? Join our [Discord Community](https://upstash.com/discord) or open an issue on [GitHub](https://github.com/upstash/context7/issues).
diff --git a/docs/installation.mdx b/docs/installation.mdx
new file mode 100644
index 00000000..7582431c
--- /dev/null
+++ b/docs/installation.mdx
@@ -0,0 +1,753 @@
+---
+title: Installation
+sidebarTitle: Installation
+---
+
+Get Context7 MCP up and running in your favorite AI coding assistant in minutes.
+
+## Requirements
+
+Before you begin, make sure you have:
+
+- **MCP Client**: Cursor, Claude Code, VS Code, Windsurf, or another MCP-compatible IDE
+- **API Key** (Recommended): For higher rate limits and private repositories. Get yours at [context7.com/dashboard](https://context7.com/dashboard)
+
+<Warning>
+**SSE Protocol Deprecation Notice**
+
+The Server-Sent Events (SSE) transport protocol is deprecated and its endpoint will be removed in upcoming releases. Please use HTTP or stdio transport methods instead.
+</Warning>
+
+## Quick Install
+
+### Via Smithery
+
+Install Context7 MCP automatically for any client via [Smithery](https://smithery.ai/server/@upstash/context7-mcp):
+
+```bash
+npx -y @smithery/cli@latest install @upstash/context7-mcp --client <CLIENT_NAME> --key <YOUR_SMITHERY_KEY>
+```
+
+Find your Smithery key at [smithery.ai](https://smithery.ai/server/@upstash/context7-mcp).
+
+## Client-Specific Installation
+
+<AccordionGroup>
+ <Accordion title="Cursor" icon="code">
+ Go to: `Settings` β†’ `Cursor Settings` β†’ `MCP` β†’ `Add new global MCP server`
+
+ Since Cursor 1.0, you can use one-click installation or manually add to `~/.cursor/mcp.json`.
+
+ **Remote Server (Recommended)**:
+
+ [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D)
+
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+
+ [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IC15IEB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)
+
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Claude Code" icon="code">
+ **Remote Server**:
+ ```bash
+ claude mcp add --transport http context7 https://mcp.context7.com/mcp \
+ --header "CONTEXT7_API_KEY: YOUR_API_KEY"
+ ```
+
+ **Local Server**:
+ ```bash
+ claude mcp add context7 -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY
+ ```
+ </Accordion>
+
+ <Accordion title="VS Code" icon="code">
+ Add to your VS Code MCP config:
+
+ **Remote Server**:
+ ```json
+ "mcp": {
+ "servers": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ "mcp": {
+ "servers": {
+ "context7": {
+ "type": "stdio",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Windsurf" icon="wind">
+ **Remote Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "serverUrl": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Amp" icon="terminal">
+ **Without API Key**:
+ ```sh
+ amp mcp add context7 https://mcp.context7.com/mcp
+ ```
+
+ **With API Key**:
+ ```sh
+ amp mcp add context7 --header "CONTEXT7_API_KEY=YOUR_API_KEY" https://mcp.context7.com/mcp
+ ```
+ </Accordion>
+
+ <Accordion title="Cline" icon="robot">
+ Install through the [Cline MCP Server Marketplace](https://cline.bot/mcp-marketplace):
+
+ 1. Open **Cline**
+ 2. Click the hamburger menu (☰) β†’ **MCP Servers**
+ 3. Search for **Context7** in the **Marketplace** tab
+ 4. Click **Install**
+
+ Or manually edit configuration:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp",
+ "type": "streamableHttp",
+ "headers": {
+ "Authorization": "Bearer YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Zed" icon="text">
+ Install via [Zed Extensions](https://zed.dev/extensions?query=Context7) or add to `settings.json`:
+
+ ```json
+ {
+ "context_servers": {
+ "Context7": {
+ "source": "custom",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Augment Code" icon="a">
+ **Via UI**:
+ 1. Hamburger menu β†’ **Settings** β†’ **Tools**
+ 2. Click **+ Add MCP**
+ 3. Enter command: `npx -y @upstash/context7-mcp@latest`
+ 4. Name: **Context7**
+
+ **Manual Configuration**:
+ ```json
+ "augment.advanced": {
+ "mcpServers": [
+ {
+ "name": "context7",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ ]
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Roo Code" icon="code">
+ **Remote Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "type": "streamable-http",
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Gemini CLI" icon="google">
+ Open `~/.gemini/settings.json` and add:
+
+ **Remote Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "httpUrl": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY",
+ "Accept": "application/json, text/event-stream"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Claude Desktop" icon="message">
+ **Remote Server**:
+ Settings β†’ Connectors β†’ Add Custom Connector
+ - Name: `Context7`
+ - URL: `https://mcp.context7.com/mcp`
+
+ **Local Server** (`claude_desktop_config.json`):
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Opencode" icon="code">
+ **Remote Server**:
+ ```json
+ "mcp": {
+ "context7": {
+ "type": "remote",
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ },
+ "enabled": true
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcp": {
+ "context7": {
+ "type": "local",
+ "command": ["npx", "-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "enabled": true
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="OpenAI Codex" icon="openai">
+ Add to your MCP server settings:
+
+ ```toml
+ [mcp_servers.context7]
+ args = ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ command = "npx"
+ ```
+
+ **Windows**: Use full paths if you encounter timeout errors:
+ ```toml
+ [mcp_servers.context7]
+ command = "C:\\Program Files\\nodejs\\node.exe"
+ args = [
+ "C:\\Users\\yourname\\AppData\\Roaming\\npm\\node_modules\\@upstash\\context7-mcp\\dist\\index.js",
+ "--transport", "stdio", "--api-key", "YOUR_API_KEY"
+ ]
+ ```
+
+ **macOS**: Use full Node.js path if needed:
+ ```toml
+ [mcp_servers.context7]
+ command = "/Users/yourname/.nvm/versions/node/v22.14.0/bin/node"
+ args = [
+ "/Users/yourname/.nvm/versions/node/v22.14.0/lib/node_modules/@upstash/context7-mcp/dist/index.js",
+ "--transport", "stdio", "--api-key", "YOUR_API_KEY"
+ ]
+ ```
+ </Accordion>
+
+ <Accordion title="JetBrains AI Assistant" icon="code">
+ 1. Go to `Settings` β†’ `Tools` β†’ `AI Assistant` β†’ `Model Context Protocol (MCP)`
+ 2. Click `+ Add`
+ 3. Select `As JSON` from the top-left dropdown
+ 4. Add configuration:
+
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+
+ 5. Click `Apply`
+ </Accordion>
+
+ <Accordion title="Kiro" icon="k">
+ 1. Navigate `Kiro` β†’ `MCP Servers`
+ 2. Click `+ Add`
+ 3. Add configuration:
+
+ ```json
+ {
+ "mcpServers": {
+ "Context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "env": {},
+ "disabled": false,
+ "autoApprove": []
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Trae" icon="robot">
+ **Remote Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="LM Studio" icon="microchip">
+ [![Add MCP Server context7 to LM Studio](https://files.lmstudio.ai/deeplink/mcp-install-light.svg)](https://lmstudio.ai/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB1cHN0YXNoL2NvbnRleHQ3LW1jcCJdfQ%3D%3D)
+
+ Or manually: `Program` β†’ `Install` β†’ `Edit mcp.json`:
+
+ ```json
+ {
+ "mcpServers": {
+ "Context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Visual Studio 2022" icon="microsoft">
+ **Remote Server**:
+ ```json
+ {
+ "inputs": [],
+ "servers": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcp": {
+ "servers": {
+ "context7": {
+ "type": "stdio",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Crush" icon="terminal">
+ **Remote Server**:
+ ```json
+ {
+ "$schema": "https://charm.land/crush.json",
+ "mcp": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ }
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "$schema": "https://charm.land/crush.json",
+ "mcp": {
+ "context7": {
+ "type": "stdio",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="BoltAI" icon="bolt">
+ Open Settings β†’ Plugins and add:
+
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+
+ Use `get-library-docs` in chat with your Context7 documentation ID.
+ </Accordion>
+
+ <Accordion title="Rovo Dev CLI" icon="terminal">
+ Edit your config:
+ ```bash
+ acli rovodev mcp
+ ```
+
+ **Remote Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Zencoder" icon="code">
+ 1. Go to Zencoder menu (...)
+ 2. Select **Agent tools**
+ 3. Click **Add custom MCP**
+ 4. Add configuration:
+
+ ```json
+ {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Qodo Gen" icon="code">
+ 1. Open Qodo Gen chat panel
+ 2. Click **Connect more tools**
+ 3. Click **+ Add new MCP**
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+
+ **Remote Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Perplexity Desktop" icon="search">
+ 1. Navigate `Perplexity` β†’ `Settings` β†’ `Connectors`
+ 2. Click `Add Connector` β†’ `Advanced`
+ 3. Server Name: `Context7`
+ 4. Add configuration:
+
+ ```json
+ {
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "command": "npx",
+ "env": {}
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Warp" icon="terminal">
+ 1. Navigate `Settings` β†’ `AI` β†’ `Manage MCP servers`
+ 2. Click `+ Add`
+ 3. Add configuration:
+
+ ```json
+ {
+ "Context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "env": {},
+ "working_directory": null,
+ "start_on_launch": true
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Copilot Coding Agent" icon="github">
+ Add to your Copilot configuration (Repository β†’ Settings β†’ Copilot β†’ Coding agent β†’ MCP configuration):
+
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp",
+ "headers": {
+ "CONTEXT7_API_KEY": "YOUR_API_KEY"
+ },
+ "tools": ["get-library-docs", "resolve-library-id"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Amazon Q Developer CLI" icon="amazon">
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+ }
+ ```
+ </Accordion>
+
+ <Accordion title="Windows Configuration" icon="windows">
+ On Windows, configuration differs slightly. Use `cmd` with `/c`:
+
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "command": "cmd",
+ "args": ["/c", "npx", "-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
+ "disabled": false,
+ "autoApprove": []
+ }
+ }
+ }
+ ```
+ </Accordion>
+</AccordionGroup>
+
+## Alternative Runtimes
+
+### Using Bun
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "bunx",
+ "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
+ }
+ }
+}
+```
+
+### Using Deno
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "deno",
+ "args": [
+ "run",
+ "--allow-env=NO_DEPRECATION,TRACE_DEPRECATION",
+ "--allow-net",
+ "npm:@upstash/context7-mcp"
+ ]
+ }
+ }
+}
+```
+
+## Using Docker
+
+Create a `Dockerfile`:
+
+```dockerfile
+FROM node:18-alpine
+WORKDIR /app
+RUN npm install -g @upstash/context7-mcp
+CMD ["context7-mcp"]
+```
+
+Build and configure:
+
+```bash
+docker build -t context7-mcp .
+```
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "docker",
+ "args": ["run", "-i", "--rm", "context7-mcp"]
+ }
+ }
+}
+```
+
+## Desktop Extension
+
+Install the [context7.mcpb](https://github.com/upstash/context7/blob/master/mcpb/context7.mcpb) file. See [MCP bundles docs](https://github.com/anthropics/mcpb#mcp-bundles-mcpb) for details.
+
+## Verify Installation
+
+Test your setup with the MCP Inspector:
+
+```bash
+npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp
+```
+
+<Tip>
+Having trouble? Check our [Troubleshooting Guide](/troubleshooting) for common issues and solutions.
+</Tip>
diff --git a/docs/mcp.mdx b/docs/mcp.mdx
deleted file mode 100644
index 0655e066..00000000
--- a/docs/mcp.mdx
+++ /dev/null
@@ -1,285 +0,0 @@
----
-title: MCP Server
----
-
-Context7 implements the Model Context Protocol (MCP) to provide up-to-date library documentation directly to AI coding assistants.
-
-## Overview
-
-The Context7 MCP Server is a lightweight service that bridges AI assistants with Context7's documentation database. It provides two main tools that work together to fetch relevant, version-specific documentation.
-
-## Quick Start
-
-- **Remote (recommended)**: Point your IDE to `https://mcp.context7.com/mcp` and supply your API key in the headers.
-- **Local**: Run `npx -y @upstash/context7-mcp --transport stdio --api-key YOUR_API_KEY` and connect over stdio.
-- **Validate**: Use `npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp` to confirm connectivity and tool availability.
-
-### Server Information
-
-- **Name**: Context7
-- **Version**: 1.0.13
-- **Protocol**: Model Context Protocol (MCP)
-- **Transport**: Supports both `stdio` and `http`
-
-## Available Tools
-
-### 1. resolve-library-id
-
-Resolves a package/product name to a Context7-compatible library ID and returns a list of matching libraries.
-
-#### When to Use
-
-You **MUST** call this function before `get-library-docs` to obtain a valid Context7-compatible library ID, **UNLESS** the user explicitly provides a library ID in the format `/org/project` or `/org/project/version` in their query.
-
-#### Input Schema
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `libraryName` | string | Yes | Library name to search for and retrieve a Context7-compatible library ID |
-
-#### Selection Process
-
-The tool analyzes the query and returns the most relevant match based on:
-
-1. **Name similarity** to the query (exact matches prioritized)
-2. **Description relevance** to the query's intent
-3. **Documentation coverage** (prioritize libraries with higher Code Snippet counts)
-4. **Trust score** (consider libraries with scores of 7-10 more authoritative)
-
-#### Response Format
-
-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
-- **Trust Score**: Authority indicator (0-10)
-- **Versions**: List of available versions (format: `/org/project/version`)
-
-#### Example Usage
-
-```json
-{
- "libraryName": "next.js"
-}
-```
-
-**Response:**
-
-```
-Available Libraries (top matches):
-
-Library ID: /vercel/next.js
-Name: Next.js
-Description: The React Framework for Production
-Code Snippets: 1,234
-Trust Score: 10
-Versions: ["/vercel/next.js/v14.0.0", "/vercel/next.js/v13.5.0"]
-```
-
-### 2. get-library-docs
-
-Fetches up-to-date documentation for a library using a Context7-compatible library ID.
-
-#### When to Use
-
-Call this function after obtaining a library ID from `resolve-library-id`, or when the user provides a library ID directly in the format `/org/project` or `/org/project/version`.
-
-#### Input Schema
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `context7CompatibleLibraryID` | string | Yes | Exact Context7-compatible library ID (e.g., `/mongodb/docs`, `/vercel/next.js`, `/supabase/supabase`) |
-| `topic` | string | No | Topic to focus documentation on (e.g., `hooks`, `routing`) |
-| `tokens` | number | No | Maximum number of tokens of documentation to retrieve (default: 5000, minimum: 1000) |
-
-#### Response
-
-Returns documentation in plain text format, optimized for AI consumption. The documentation includes:
-
-- API references
-- Code examples
-- Configuration guides
-- Best practices
-- Version-specific information
-
-#### Example Usage
-
-```json
-{
- "context7CompatibleLibraryID": "/vercel/next.js",
- "topic": "middleware",
- "tokens": 5000
-}
-```
-
-## Transport Types
-
-Context7 MCP Server supports two transport protocols:
-
-### stdio (Default)
-
-Standard input/output transport for local MCP clients.
-
-**Use case**: Local installations with Cursor, VS Code, Claude Code, etc.
-
-**Configuration example:**
-
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "npx",
- "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
- }
- }
-}
-```
-
-### http
-
-HTTP/HTTPS transport for remote server connections.
-
-**Use case**: Remote deployments, cloud installations, multiple client connections.
-
-**Configuration example:**
-
-```json
-{
- "mcpServers": {
- "context7": {
- "url": "https://mcp.context7.com/mcp",
- "headers": {
- "CONTEXT7_API_KEY": "YOUR_API_KEY"
- }
- }
- }
-}
-```
-
-**Endpoints:**
-
-- `/mcp` - Main MCP endpoint (StreamableHTTP)
-- `/sse` - Server-Sent Events endpoint (GET)
-- `/messages` - SSE message endpoint (POST)
-- `/ping` - Health check endpoint
-
-<Warning>
-The Server-Sent Events (SSE) transport protocol is deprecated and its endpoint will be removed in upcoming releases. Please use HTTP or stdio transport methods instead.
-</Warning>
-
-## CLI Arguments
-
-The Context7 MCP server accepts the following command-line arguments:
-
-| Argument | Values | Default | Description |
-|----------|--------|---------|-------------|
-| `--transport` | `stdio` \| `http` | `stdio` | Transport protocol to use |
-| `--port` | number | `3000` | Port for HTTP transport (only with `--transport http`) |
-| `--api-key` | string | - | API key for authentication (only with `--transport stdio`) |
-
-### Examples
-
-**HTTP transport on port 8080:**
-
-```bash
-npx @upstash/context7-mcp --transport http --port 8080
-```
-
-**stdio transport with API key:**
-
-```bash
-npx @upstash/context7-mcp --transport stdio --api-key YOUR_API_KEY
-```
-
-<Note>
-- The `--api-key` flag is not allowed when using `--transport http`. Use header-based authentication instead.
-- The `--port` flag is not allowed when using `--transport stdio`.
-</Note>
-
-## Authentication
-
-### API Keys
-
-Context7 supports optional API key authentication for:
-
-- Higher rate limits
-- Access to private repositories
-- Usage tracking
-
-Get your API key at [context7.com/dashboard](https://context7.com/dashboard).
-
-### Header Support
-
-For HTTP transport, the server checks the following headers in order:
-
-1. `Authorization: Bearer <token>`
-2. `Context7-API-Key: <key>`
-3. `X-API-Key: <key>`
-4. `context7-api-key: <key>`
-5. `x-api-key: <key>`
-
-## Error Handling
-
-The server returns descriptive error messages for common scenarios:
-
-| Error Code | Description |
-|------------|-------------|
-| 401 | Unauthorized - Invalid or missing API key |
-| 404 | Library not found - Invalid library ID |
-| 429 | Rate limited - Too many requests |
-| 500 | Internal server error |
-
-## Rate Limits
-
-- **Without API key**: Limited requests per IP
-- **With API key**: Higher limits based on your plan
-
-## Proxy Support
-
-Context7 automatically detects and uses HTTP/HTTPS proxy settings from environment variables:
-
-- `HTTPS_PROXY` / `https_proxy`
-- `HTTP_PROXY` / `http_proxy`
-
-See [How To - Using HTTPS Proxy](/how-to#using-https-proxy) for configuration details.
-
-## Development
-
-### Running Locally
-
-```bash
-# Install dependencies
-bun i
-
-# Build
-bun run build
-
-# Run with stdio transport
-bun run dist/index.js --transport stdio --api-key YOUR_API_KEY
-
-# Run with HTTP transport
-bun run dist/index.js --transport http --port 3000
-```
-
-### Testing with MCP Inspector
-
-```bash
-npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp
-```
-
-## Best Practices
-
-1. **Always resolve library IDs first**: Call `resolve-library-id` before `get-library-docs` unless you have an explicit library ID
-2. **Use appropriate token limits**: Higher token counts provide more context but consume more resources
-3. **Specify topics**: Use the `topic` parameter to focus documentation on specific areas
-4. **Handle errors gracefully**: Check for error responses and provide fallback behavior
-5. **Cache results**: Consider caching documentation responses to reduce API calls
-
-## Source Code
-
-The Context7 MCP server is open source:
-
-- GitHub: [github.com/upstash/context7](https://github.com/upstash/context7)
-- NPM: [@upstash/context7-mcp](https://www.npmjs.com/package/@upstash/context7-mcp)
diff --git a/docs/overview.mdx b/docs/overview.mdx
new file mode 100644
index 00000000..f3f7f13f
--- /dev/null
+++ b/docs/overview.mdx
@@ -0,0 +1,36 @@
+---
+title: Getting Started with Context7
+sidebarTitle: Getting Started
+---
+
+Context7 brings up-to-date, version-specific documentation and code examples directly into your AI coding assistant. No more outdated examples or hallucinated APIs.
+
+## ❌ 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 MCP pulls up-to-date, version-specific documentation and code examples straight from the source β€” and places them directly into your prompt.
+
+Add `use context7` to your prompt in Cursor:
+
+```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
+```
+
+Context7 fetches up-to-date code examples and documentation right into your LLM's context.
+
+- 1️⃣ Write your prompt naturally
+- 2️⃣ Tell the LLM to `use context7`
+- 3️⃣ Get working code answers
+
+No tab-switching, no hallucinated APIs that don't exist, no outdated code generation.
diff --git a/docs/plans-pricing.mdx b/docs/plans-pricing.mdx
index 05ccbe53..4a78348e 100644
--- a/docs/plans-pricing.mdx
+++ b/docs/plans-pricing.mdx
@@ -6,186 +6,22 @@ Pick the plan that matches how you work today and scale when your needs grow.
## Compare Plans
-<CardGroup cols={3}>
- <Card title="Free" icon="gift">
- **$0**
-
- Perfect for individual developers
-
- **Features:**
- - Public Repositories
- - Access Control
- - API Usage (60 req/hr)
- - Community Support
-
- [Get Started Free β†’](https://context7.com/dashboard)
- </Card>
-
- <Card title="Pro" icon="star">
- **$7 per seat / month**
-
- For teams that need private repos
-
- **Free Features +**
- - Private Repositories
- - Team Collaboration
- - $15/1M parse tokens
- - Email Support
-
- [Choose Pro β†’](https://context7.com/plans)
- </Card>
-
- <Card title="Enterprise" icon="building">
- **Custom Pricing**
-
- For large teams with custom needs
-
- **Pro Features +**
- - SOC-2 Compliance
- - SSO (SAML, OAuth, OIDC)
- - Custom Rate Limits
- - Dedicated Support
-
- [Contact Us β†’](https://context7.com/contact)
- </Card>
-</CardGroup>
-
-## Plan Details
-
-### Free Plan
-
-The Free plan is perfect for individual developers who want to access public documentation.
-
-**What's Included:**
-- Access to all public repositories
-- Basic access control
-- 60 API requests per hour
-- MCP server integration
-- Community support via Discord and GitHub
-
-**Limitations:**
-- No private repository access
-- No team collaboration
-- Single user only
-
-**Best For:**
-- Individual developers
-- Personal projects
-- Learning and experimentation
-- Public documentation needs
-
-### Pro Plan
-
-The Pro plan adds private repository access and team collaboration capabilities.
-
-**Pricing:**
-- **$7 per seat per month**: Each team member counts as one seat
-- **$15 per 1M parse tokens**: For parsing private repositories (adding or refreshing)
-
-**What's Included:**
-- Everything in Free plan
-- Private repository access
-- Team collaboration (up to 20 members per project)
-- 60 requests/hour per team member
-- Email support
-- Usage analytics and monitoring
-
-**How Billing Works:**
-1. **Member Seats**: Charged monthly based on the number of team members
-2. **Parse Tokens**: Charged when adding or refreshing private repositories
-3. **Pro-rated Charges**: Billed based on days in the current billing period
-4. **Cached Pages**: Free when refreshing (only new/changed content is charged)
-
-<Note>
-Parse tokens measure how much *documentation* Context7 processes during ingestionβ€”querying already-indexed docs stays free.
-</Note>
-
-**Example Costs:**
-- 3 team members: $21/month (3 Γ— $7)
-- Adding a 500K token private repo: $7.50 one-time (0.5M Γ— $15)
-- Total first month: $28.50
-
-**Best For:**
-- Development teams
-- Projects with private repositories
-- Organizations needing collaboration
-- Teams with proprietary documentation
-
-### Enterprise Plan
-
-The Enterprise plan provides custom solutions for large organizations.
-
-**Custom Pricing:**
-Contact us at [[email protected]](mailto:[email protected]) for customized pricing based on your needs.
-
-**What's Included:**
-- Everything in Pro plan
-- SOC-2 Type II compliance
-- SSO authentication (SAML, OAuth 2.0, OIDC)
-- Custom rate limits
-- Dedicated support team
-- Priority feature requests
-- Custom SLA
-- Regular check-ins
-- Advanced security features
-
-**Best For:**
-- Large enterprises
-- Organizations requiring SOC-2 compliance
-- Teams with high-volume API usage
-- Companies needing SSO integration
-
-## Pricing Details
-
-### Parse Token Pricing
-
-When you add or refresh a private repository, you're charged $15 per 1 million tokens parsed.
-
-**What Counts as Parsing:**
-- Initial addition of a private repository
-- Refreshing a private repository (only new/changed content)
-- Processing documentation and code examples
-
-**What's Free:**
-- Cached pages during refresh (unchanged content)
-- Public repository access
-- Querying documentation via API (covered by seat cost)
-
-**Example Scenarios:**
-
-<AccordionGroup>
- <Accordion title="Adding a Private Repository">
- - Repository documentation size: 750K tokens
- - Cost: $11.25 (0.75M Γ— $15)
- - This is a one-time charge when adding the repository
- </Accordion>
-
- <Accordion title="Refreshing a Repository">
- - Previous size: 750K tokens
- - New content: 50K tokens
- - Cached (unchanged): 700K tokens
- - Cost: $0.75 (0.05M Γ— $15)
- - You only pay for the new/changed content
- </Accordion>
-
- <Accordion title="Monthly Team Cost">
- - Team members: 5
- - Seat cost: $35/month (5 Γ— $7)
- - Added 2 private repos: $30 (2M tokens Γ— $15)
- - Refreshed repos: $5 (0.33M new tokens Γ— $15)
- - Total: $70 for the month
- </Accordion>
-</AccordionGroup>
-
-### Rate Limits
-
-| Plan | Rate Limit | Notes |
-|------|------------|-------|
-| Free | 60 req/hour | Per API key |
-| Pro | 60 req/hour | Per team member |
-| Enterprise | Custom | Based on your needs |
-
-Rate limits are calculated using a sliding window algorithm and reset hourly.
+| Feature | Free | Pro | Enterprise |
+|---------|------|-----|------------|
+| **Price** | $0 | $7 per seat/month | Custom |
+| **Public Repositories** | βœ“ | βœ“ | βœ“ |
+| **Private Repositories** | βœ— | βœ“ | βœ“ |
+| **Team Collaboration** | βœ— | βœ“ (up to 20 members) | βœ“ (unlimited) |
+| **API Rate Limit** | 60 req/hour | 60 req/hour per member | Custom |
+| **Parse Token Cost** | N/A | $15 per 1M tokens | Custom |
+| **Access Control** | Basic | Full | Advanced |
+| **SOC-2 Compliance** | βœ— | βœ— | βœ“ |
+| **SSO (SAML, OAuth, OIDC)** | βœ— | βœ— | βœ“ |
+| **Support** | Community | Email | Dedicated |
+| **Usage Analytics** | Basic | βœ“ | Advanced |
+| **Custom Rate Limits** | βœ— | βœ— | βœ“ |
+| **Priority Features** | βœ— | βœ— | βœ“ |
+| **Custom SLA** | βœ— | βœ— | βœ“ |
## Frequently Asked Questions
@@ -256,56 +92,3 @@ Rate limits are calculated using a sliding window algorithm and reset hourly.
No, we have different rate limits for each plan. The Free plan has lower rate limits, while the Pro plan offers higher limits per team member. If you need custom rate limits for high-volume usage, please contact us at [[email protected]](mailto:[email protected]) to discuss Enterprise plan options.
</Accordion>
</AccordionGroup>
-
-## Getting Started
-
-### Free Plan
-
-1. Sign up at [context7.com](https://context7.com)
-2. Access your dashboard at [context7.com/dashboard](https://context7.com/dashboard)
-3. Get your API key
-4. Start using Context7 with public libraries
-
-### Pro Plan
-
-1. Start with a Free account
-2. Go to [Plans & Pricing](https://context7.com/plans)
-3. Click "Choose Pro Plan"
-4. Add payment method via Stripe
-5. Create team projects and add members
-6. Add private repositories
-
-### Enterprise Plan
-
-1. Contact us at [[email protected]](mailto:[email protected])
-2. Discuss your requirements
-3. Receive custom pricing proposal
-4. Get onboarding support
-5. Start using enterprise features
-
-## Need Help Choosing?
-
-**Choose Free if:**
-- You're an individual developer
-- You only need public documentation
-- You're just getting started
-
-**Choose Pro if:**
-- You need private repository access
-- You're working in a team
-- You need collaboration features
-
-**Choose Enterprise if:**
-- You're a large organization
-- You need SOC-2 compliance
-- You require SSO integration
-- You have high-volume API usage
-
-Still not sure? [Contact us](https://context7.com/contact) and we'll help you choose the right plan.
-
-## Additional Resources
-
-- [Dashboard Guide β†’](/dashboard)
-- [API Documentation β†’](/api)
-- [Security & Privacy β†’](/security)
-- [Getting Started β†’](/getting-started)
diff --git a/docs/how-to.mdx b/docs/usage.mdx
similarity index 100%
rename from docs/how-to.mdx
rename to docs/usage.mdx