Skip to content

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

feat: update documentation links and content, fix duplicate contact page

enesgules35dca3b8b29b
diff --git a/README.md b/README.md
index 2fc3305a..bb4a758f 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@ No tab-switching, no hallucinated APIs that don't exist, no outdated code genera
## πŸ“š Adding Projects
-Check out our [project addition guide](./docs/adding-projects.md) to learn how to add (or update) your favorite libraries to Context7.
+Check out our [project addition guide](https://context7.com/docs/adding-libraries) to learn how to add (or update) your favorite libraries to Context7.
## πŸ› οΈ Installation
diff --git a/docs/contact.mdx b/docs/contact.mdx
index e9a0a2da..3a8693ec 100644
--- a/docs/contact.mdx
+++ b/docs/contact.mdx
@@ -1,350 +1,72 @@
---
-title: Troubleshooting
+title: Contact & Support
+sidebarTitle: Contact
---
-This guide helps you resolve common issues when setting up or using Context7 MCP.
+Need help or have questions? We're here to support you.
-## Quick Checklist
+## Community Support
-- 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
+### Discord
-## Installation Issues
+Join our vibrant community on Discord for:
+- Quick answers to common questions
+- Tips and best practices from other users
+- Announcements about new features and updates
+- Direct interaction with the team
-### Module Not Found Errors
+[Join Discord](https://upstash.com/discord)
-If you encounter `ERR_MODULE_NOT_FOUND`, try using `bunx` instead of `npx`:
+### GitHub
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "bunx",
- "args": ["-y", "@upstash/context7-mcp"]
- }
- }
-}
-```
+For bug reports, feature requests, and technical discussions:
-This often resolves module resolution issues in environments where `npx` doesn't properly install or resolve packages.
+- **Report Issues**: [github.com/upstash/context7/issues](https://github.com/upstash/context7/issues)
+- **View Source Code**: [github.com/upstash/context7](https://github.com/upstash/context7)
+- **Contribute**: Submit pull requests to improve Context7
-### ESM Resolution Issues
+## Social Media
-For errors like `Error: Cannot find module 'uriTemplate.js'`, try the `--experimental-vm-modules` flag:
+Stay updated with the latest news and updates:
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "npx",
- "args": ["-y", "--node-options=--experimental-vm-modules", "@upstash/[email protected]"]
- }
- }
-}
-```
+- **X (Twitter)**: [@context7ai](https://x.com/context7ai)
+- **Website**: [context7.com](https://context7.com)
-### TLS/Certificate Issues
+## Enterprise Support
-Use the `--experimental-fetch` flag to bypass TLS-related problems:
+For enterprise customers and custom solutions:
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "npx",
- "args": ["-y", "--node-options=--experimental-fetch", "@upstash/context7-mcp"]
- }
- }
-}
-```
+- **Email**: [email protected]
+- **Enterprise Plans**: Contact us for dedicated support, custom SLAs, and advanced features
-## General Solutions
+## Documentation
-### Quick Fixes
+Explore our comprehensive documentation:
-1. **Try adding `@latest`** to the package name to ensure you're using the most recent version:
+- [Getting Started](/overview) - Quick introduction to Context7
+- [Installation Guide](/installation) - Setup instructions for all platforms
+- [Usage Guide](/usage) - Tips and best practices
+- [API Reference](/api) - Complete API documentation
+- [Troubleshooting](/troubleshooting) - Common issues and solutions
+- [Security & Privacy](/security) - Security practices and compliance
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "npx",
- "args": ["-y", "@upstash/context7-mcp@latest", "--api-key", "YOUR_API_KEY"]
- }
- }
-}
-```
+## Report Security Issues
-2. **Use `bunx` as an alternative** to `npx`:
+If you discover a security vulnerability:
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "bunx",
- "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
- }
- }
-}
-```
+1. **Do not** publicly disclose the issue
+2. Report via: [GitHub Security](https://github.com/upstash/context7/security)
+3. Include detailed steps to reproduce
+4. Allow reasonable time for us to address the issue
-3. **Consider using `deno`** as another alternative runtime:
+We take all security reports seriously and will respond promptly.
-```json
-{
- "mcpServers": {
- "context7": {
- "command": "deno",
- "args": [
- "run",
- "--allow-env=NO_DEPRECATION,TRACE_DEPRECATION",
- "--allow-net",
- "npm:@upstash/context7-mcp"
- ]
- }
- }
-}
-```
+## Feedback
-4. **Ensure you're using Node.js v18 or higher** for native fetch support:
+We value your feedback! Help us improve Context7:
-```bash
-node --version
-```
+- Use the thumbs rating on documentation pages
+- Suggest edits directly on any page
+- Raise issues for bugs or feature requests
-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)
+Your input helps us build a better product for everyone.
diff --git a/docs/docs.json b/docs/docs.json
index 24a177cb..a7792891 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -17,6 +17,7 @@
"plans-pricing",
"api",
"security",
+ "troubleshooting",
"contact"
]
},
diff --git a/docs/installation.mdx b/docs/installation.mdx
index cdc1357f..afa188ce 100644
--- a/docs/installation.mdx
+++ b/docs/installation.mdx
@@ -13,9 +13,9 @@ Before you begin, make sure you have:
- **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**
+**SSE Protocol Removed**
-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.
+The Server-Sent Events (SSE) transport protocol has been removed and is no longer available. Please use HTTP or stdio transport methods instead.
</Warning>
@@ -616,6 +616,43 @@ Find your Smithery key at [smithery.ai](https://smithery.ai/server/@upstash/cont
</Accordion>
+ <Accordion title="Qwen Coder" icon="code">
+ See [Qwen Coder MCP Configuration](https://qwenlm.github.io/qwen-code-docs/en/tools/mcp-server/#how-to-set-up-your-mcp-server) for details.
+
+ 1. Open the Qwen Coder settings file. The location is `~/.qwen/settings.json` (where `~` is your home directory).
+ 2. Add the following to the `mcpServers` object in your `settings.json` file:
+
+ **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"]
+ }
+ }
+ }
+ ```
+
+ If the `mcpServers` object does not exist, create it.
+
+ </Accordion>
+
<Accordion title="Perplexity Desktop" icon="search">
1. Navigate `Perplexity` β†’ `Settings` β†’ `Connectors`
2. Click `Add Connector` β†’ `Advanced`
@@ -671,6 +708,55 @@ Find your Smithery key at [smithery.ai](https://smithery.ai/server/@upstash/cont
</Accordion>
+ <Accordion title="Copilot CLI" icon="github">
+ 1. Open the Copilot CLI MCP config file. The location is `~/.copilot/mcp-config.json` (where `~` is your home directory).
+ 2. Add the following to the `mcpServers` object in your `mcp-config.json` file:
+
+ **Remote Server**:
+ ```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"
+ ]
+ }
+ }
+ }
+ ```
+
+ **Local Server**:
+ ```json
+ {
+ "mcpServers": {
+ "context7": {
+ "type": "local",
+ "command": "npx",
+ "tools": [
+ "get-library-docs",
+ "resolve-library-id"
+ ],
+ "args": [
+ "-y",
+ "@upstash/context7-mcp",
+ "--api-key",
+ "YOUR_API_KEY"
+ ]
+ }
+ }
+ }
+ ```
+
+ If the `mcp-config.json` file does not exist, create it.
+
+ </Accordion>
+
<Accordion title="Amazon Q Developer CLI" icon="amazon">
```json
{
@@ -701,6 +787,35 @@ Find your Smithery key at [smithery.ai](https://smithery.ai/server/@upstash/cont
```
</Accordion>
+
+ <Accordion title="Factory" icon="factory">
+ Factory's droid supports MCP servers through its CLI. See [Factory MCP docs](https://docs.factory.ai/cli/configuration/mcp) for more info.
+
+ **Remote Server Connection (HTTP)**:
+
+ Run this command in your terminal:
+
+ ```sh
+ droid mcp add context7 https://mcp.context7.com/mcp --type http --header "CONTEXT7_API_KEY: YOUR_API_KEY"
+ ```
+
+ Or without an API key (basic usage with rate limits):
+
+ ```sh
+ droid mcp add context7 https://mcp.context7.com/mcp --type http
+ ```
+
+ **Local Server Connection (Stdio)**:
+
+ Run this command in your terminal:
+
+ ```sh
+ droid mcp add context7 "npx -y @upstash/context7-mcp" --env CONTEXT7_API_KEY=YOUR_API_KEY
+ ```
+
+ Once configured, Context7 tools will be available in your droid sessions. Type `/mcp` within droid to manage servers, authenticate, and view available tools.
+
+ </Accordion>
</AccordionGroup>
## Alternative Runtimes
diff --git a/docs/troubleshooting.mdx b/docs/troubleshooting.mdx
index e9a0a2da..b7f031bd 100644
--- a/docs/troubleshooting.mdx
+++ b/docs/troubleshooting.mdx
@@ -286,7 +286,7 @@ export HTTPS_PROXY=http://proxy.example.com:8080
}
```
-See [How To - Using HTTPS Proxy](/how-to#using-https-proxy) for more details.
+See [Usage Guide - Configure HTTPS Proxy](/usage#configure-https-proxy) for more details.
## Debugging Tips
@@ -343,8 +343,7 @@ If none of these solutions work:
## Additional Resources
-- [Getting Started Guide](/getting-started)
-- [Installation Instructions](/getting-started#installation)
-- [MCP Documentation](/mcp)
+- [Getting Started Guide](/overview)
+- [Installation Instructions](/installation)
- [API Documentation](/api)
- [Security & Privacy](/security)
diff --git a/docs/usage.mdx b/docs/usage.mdx
index 94be06df..8d18b483 100644
--- a/docs/usage.mdx
+++ b/docs/usage.mdx
@@ -19,7 +19,7 @@ Stop adding "use context7" to every prompt by setting up an automatic rule.
### Add a Rule to Your MCP Client
<AccordionGroup>
- <Accordion title="Cursor" icon="cursor">
+ <Accordion title="Cursor" icon="code">
1. Open `Cursor Settings` β†’ `Rules`
2. Add this rule:
@@ -191,19 +191,20 @@ Access your private documentation with Context7 Pro.
### Requirements
- Pro plan ($7/seat/month)
-- GitHub or GitLab personal access token
+- GitHub, GitLab, or Bitbucket account connection
- Repository access permissions
### Add a Private Repository
1. Go to [Dashboard β†’ Libraries β†’ Private Repositories](https://context7.com/dashboard)
2. Click **Add Private Repository**
-3. Enter repository URL
-4. Provide access token:
- - **GitHub**: Token with `repo` scope
- - **GitLab**: Token with `read_repository` scope
-5. Configure folders and exclusions (optional)
-6. Submit
+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)
+5. Authorize Context7 to access your repository
+6. Configure folders and exclusions (optional)
+7. Submit
### Cost
@@ -240,7 +241,7 @@ Each team member gets their own API key with independent rate limits (60 req/hou
Regenerate keys from the Members tab if compromised.
-See [Dashboard β†’ Team Collaboration](/dashboard#team-collaboration) for details.
+Visit the [Dashboard](https://context7.com/dashboard) for team management details.
## Refresh Library Documentation
@@ -302,7 +303,7 @@ All stats show the last 30 days.
- Added 800K token private repo: $12 one-time
- Monthly total: $40
-See [Dashboard β†’ Usage Monitoring](/dashboard#usage-monitoring) for more details.
+Visit the [Dashboard](https://context7.com/dashboard) to monitor your usage and costs.
## Best Practices