Context7 Platform -- Up-to-date docs for AI agents
README: sorting the installation instructions by coding tool in alphabetical order
Philip Fung61b07d96d9c5
diff --git a/README.md b/README.mdindex 251ecb14..f5647899 100644--- a/README.md+++ b/README.md@@ -45,113 +45,73 @@ Check out our [project addition guide](./docs/adding-projects.md) to learn how t- Node.js >= v18.0.0- Cursor, Windsurf, Claude Desktop or another MCP Client-<details>-<summary><b>Installing via Smithery</b></summary>--To install Context7 MCP Server for any client automatically 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>-```--You can find your Smithery key in the [Smithery.ai webpage](https://smithery.ai/server/@upstash/context7-mcp).--</details><details>-<summary><b>Install in Cursor</b></summary>--Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`--Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.--> Since Cursor 1.0, you can click the install button below for instant one-click installation.--#### Cursor Remote Server Connection+<summary><b>Install in Amazon Q Developer CLI</b></summary>-[](https://cursor.com/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D)+Add this to your Amazon Q Developer CLI configuration file. See [Amazon Q Developer CLI docs](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html) for more details.```json{"mcpServers": {"context7": {- "url": "https://mcp.context7.com/mcp"+ "command": "npx",+ "args": ["-y", "@upstash/context7-mcp@latest"]}}}```+</details>-#### Cursor Local Server Connection+<details>+<summary><b>Install in Augment Code</b></summary>-[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IC15IEB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)+To configure Context7 MCP in Augment Code, you can use either the graphical interface or manual configuration.-```json-{- "mcpServers": {- "context7": {- "command": "npx",- "args": ["-y", "@upstash/context7-mcp"]- }- }-}-```+### **A. Using the Augment Code UI**-<details>-<summary>Alternative: Use Bun</summary>+1. Click the hamburger menu.+2. Select **Settings**.+3. Navigate to the **Tools** section.+4. Click the **+ Add MCP** button.+5. Enter the following command:-[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoiYnVueCAteSBAdXBzdGFzaC9jb250ZXh0Ny1tY3AifQ%3D%3D)+ ```+ npx -y @upstash/context7-mcp@latest+ ```-```json-{- "mcpServers": {- "context7": {- "command": "bunx",- "args": ["-y", "@upstash/context7-mcp"]- }- }-}-```+6. Name the MCP: **Context7**.+7. Click the **Add** button.-</details>+Once the MCP server is added, you can start using Context7's up-to-date code documentation features directly within Augment Code.-<details>-<summary>Alternative: Use Deno</summary>+----[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoiZGVubyBydW4gLS1hbGxvdy1lbnYgLS1hbGxvdy1uZXQgbnBtOkB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)+### **B. Manual Configuration**-```json+1. Press Cmd/Ctrl Shift P or go to the hamburger menu in the Augment panel+2. Select Edit Settings+3. Under Advanced, click Edit in settings.json+4. Add the server configuration to the `mcpServers` array in the `augment.advanced` object++"augment.advanced": {+"mcpServers": [{- "mcpServers": {- "context7": {- "command": "deno",- "args": ["run", "--allow-env=NO_DEPRECATION,TRACE_DEPRECATION", "--allow-net", "npm:@upstash/context7-mcp"]- }- }+"name": "context7",+"command": "npx",+"args": ["-y", "@upstash/context7-mcp"]+}+]}-```-</details>+Once the MCP server is added, restart your editor. If you receive any errors, check the syntax to make sure closing brackets or commas are not missing.</details><details>-<summary><b>Install in Windsurf</b></summary>--Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/mcp) for more info.--#### Windsurf Remote Server Connection--```json-{- "mcpServers": {- "context7": {- "serverUrl": "https://mcp.context7.com/sse"- }- }-}-```+<summary><b>Install in BoltAI</b></summary>-#### Windsurf Local Server Connection+Open the "Settings" page of the app, navigate to "Plugins," and enter the following JSON:```json{@@ -164,36 +124,38 @@ Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.}```+Once saved, enter in the chat `get-library-docs` followed by your Context7 documentation ID (e.g., `get-library-docs /nuxt/ui`). More information is available on [BoltAI's Documentation site](https://docs.boltai.com/docs/plugins/mcp-servers). For BoltAI on iOS, [see this guide](https://docs.boltai.com/docs/boltai-mobile/mcp-servers).+</details><details>-<summary><b>Install in VS Code</b></summary>+<summary><b>Install in Claude Code</b></summary>-[<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Context7%20MCP&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)-[<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Context7%20MCP&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)+Run this command. See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp) for more info.-Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.+#### Claude Code Remote Server Connection-#### VS Code Remote Server Connection+```sh+claude mcp add --transport sse context7 https://mcp.context7.com/sse+```-```json-"mcp": {- "servers": {- "context7": {- "type": "http",- "url": "https://mcp.context7.com/mcp"- }- }-}+#### Claude Code Local Server Connection++```sh+claude mcp add context7 -- npx -y @upstash/context7-mcp```-#### VS Code Local Server Connection+</details>++<details>+<summary><b>Install in Claude Desktop</b></summary>++Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.```json-"mcp": {- "servers": {- "context7": {- "type": "stdio",+{+ "mcpServers": {+ "Context7": {"command": "npx","args": ["-y", "@upstash/context7-mcp"]}@@ -204,94 +166,53 @@ Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.vi</details><details>-<summary><b>Install in Visual Studio 2022</b></summary>+<summary><b>Install in Cursor</b></summary>-You can configure Context7 MCP in Visual Studio 2022 by following the [Visual Studio MCP Servers documentation](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022).+Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`-Add this to your Visual Studio MCP config file (see the [Visual Studio docs](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022) for details):+Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.-```json-{- "mcp": {- "servers": {- "context7": {- "type": "http",- "url": "https://mcp.context7.com/mcp"- }- }- }-}-```+> Since Cursor 1.0, you can click the install button below for instant one-click installation.-Or, for a local server:+#### Cursor Remote Server Connection++[](https://cursor.com/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D)```json{- "mcp": {- "servers": {- "context7": {- "type": "stdio",- "command": "npx",- "args": ["-y", "@upstash/context7-mcp"]- }+ "mcpServers": {+ "context7": {+ "url": "https://mcp.context7.com/mcp"}}}```-For more information and troubleshooting, refer to the [Visual Studio MCP Servers documentation](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022).-</details>--<details>-<summary><b>Install in Zed</b></summary>+#### Cursor Local Server Connection-It can be installed via [Zed Extensions](https://zed.dev/extensions?query=Context7) or you can add this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.+[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IC15IEB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)```json{- "context_servers": {- "Context7": {- "command": {- "path": "npx",- "args": ["-y", "@upstash/context7-mcp"]- },- "settings": {}+ "mcpServers": {+ "context7": {+ "command": "npx",+ "args": ["-y", "@upstash/context7-mcp"]}}}```-</details>-<details>-<summary><b>Install in Claude Code</b></summary>--Run this command. See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp) for more info.--#### Claude Code Remote Server Connection--```sh-claude mcp add --transport sse context7 https://mcp.context7.com/sse-```--#### Claude Code Local Server Connection--```sh-claude mcp add context7 -- npx -y @upstash/context7-mcp-```--</details>--<details>-<summary><b>Install in Claude Desktop</b></summary>+<summary>Alternative: Use Bun</summary>-Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.+[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoiYnVueCAteSBAdXBzdGFzaC9jb250ZXh0Ny1tY3AifQ%3D%3D)```json{"mcpServers": {- "Context7": {- "command": "npx",+ "context7": {+ "command": "bunx","args": ["-y", "@upstash/context7-mcp"]}}@@ -301,25 +222,26 @@ Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude D</details><details>-<summary><b>Install in BoltAI</b></summary>+<summary>Alternative: Use Deno</summary>-Open the "Settings" page of the app, navigate to "Plugins," and enter the following JSON:+[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoiZGVubyBydW4gLS1hbGxvdy1lbnYgLS1hbGxvdy1uZXQgbnBtOkB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)```json{"mcpServers": {"context7": {- "command": "npx",- "args": ["-y", "@upstash/context7-mcp"]+ "command": "deno",+ "args": ["run", "--allow-env=NO_DEPRECATION,TRACE_DEPRECATION", "--allow-net", "npm:@upstash/context7-mcp"]}}}```-Once saved, enter in the chat `get-library-docs` followed by your Context7 documentation ID (e.g., `get-library-docs /nuxt/ui`). More information is available on [BoltAI's Documentation site](https://docs.boltai.com/docs/plugins/mcp-servers). For BoltAI on iOS, [see this guide](https://docs.boltai.com/docs/boltai-mobile/mcp-servers).+</details></details>+<details><summary><b>Using Docker</b></summary>@@ -380,95 +302,141 @@ If you prefer to run the MCP server in a Docker container:</details>+<details>-<summary><b>Install in Windows</b></summary>+<summary><b>Install in Qodo Gen</b></summary>-The configuration on Windows is slightly different compared to Linux or macOS (_`Cline` is used in the example_). The same principle applies to other editors; refer to the configuration of `command` and `args`.+See [Qodo Gen docs](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps) for more details.++1. Open Qodo Gen chat panel in VSCode or IntelliJ.+2. Click Connect more tools.+3. Click + Add new MCP.+4. Add the following configuration:```json{"mcpServers": {- "github.com/upstash/context7-mcp": {- "command": "cmd",- "args": ["/c", "npx", "-y", "@upstash/context7-mcp@latest"],- "disabled": false,- "autoApprove": []+ "context7": {+ "url": "https://mcp.context7.com/mcp"}}}```-</details><details>-<summary><b>Install in Augment Code</b></summary>+<summary><b>Install in Roo Code</b></summary>-To configure Context7 MCP in Augment Code, you can use either the graphical interface or manual configuration.+Add this to your Roo Code MCP configuration file. See [Roo Code MCP docs](https://docs.roocode.com/features/mcp/using-mcp-in-roo) for more info.-### **A. Using the Augment Code UI**+#### Roo Code Remote Server Connection-1. Click the hamburger menu.-2. Select **Settings**.-3. Navigate to the **Tools** section.-4. Click the **+ Add MCP** button.-5. Enter the following command:+```json+{+ "mcpServers": {+ "context7": {+ "type": "streamable-http",+ "url": "https://mcp.context7.com/mcp"+ }+ }+}+```- ```- npx -y @upstash/context7-mcp@latest- ```+#### Roo Code Local Server Connection-6. Name the MCP: **Context7**.-7. Click the **Add** button.+```json+{+ "mcpServers": {+ "context7": {+ "command": "npx",+ "args": ["-y", "@upstash/context7-mcp"]+ }+ }+}+```-Once the MCP server is added, you can start using Context7's up-to-date code documentation features directly within Augment Code.+</details>----+<details>+<summary><b>Installing via Smithery</b></summary>-### **B. Manual Configuration**+To install Context7 MCP Server for any client automatically via [Smithery](https://smithery.ai/server/@upstash/context7-mcp):-1. Press Cmd/Ctrl Shift P or go to the hamburger menu in the Augment panel-2. Select Edit Settings-3. Under Advanced, click Edit in settings.json-4. Add the server configuration to the `mcpServers` array in the `augment.advanced` object+```bash+npx -y @smithery/cli@latest install @upstash/context7-mcp --client <CLIENT_NAME> --key <YOUR_SMITHERY_KEY>+```-"augment.advanced": {-"mcpServers": [+You can find your Smithery key in the [Smithery.ai webpage](https://smithery.ai/server/@upstash/context7-mcp).++</details>++<details>+<summary><b>Install in Visual Studio 2022</b></summary>++You can configure Context7 MCP in Visual Studio 2022 by following the [Visual Studio MCP Servers documentation](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022).++Add this to your Visual Studio MCP config file (see the [Visual Studio docs](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022) for details):++```json{-"name": "context7",-"command": "npx",-"args": ["-y", "@upstash/context7-mcp"]-}-]+ "mcp": {+ "servers": {+ "context7": {+ "type": "http",+ "url": "https://mcp.context7.com/mcp"+ }+ }+ }}+```-Once the MCP server is added, restart your editor. If you receive any errors, check the syntax to make sure closing brackets or commas are not missing.+Or, for a local server:++```json+{+ "mcp": {+ "servers": {+ "context7": {+ "type": "stdio",+ "command": "npx",+ "args": ["-y", "@upstash/context7-mcp"]+ }+ }+ }+}+```+For more information and troubleshooting, refer to the [Visual Studio MCP Servers documentation](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022).</details><details>-<summary><b>Install in Roo Code</b></summary>+<summary><b>Install in VS Code</b></summary>-Add this to your Roo Code MCP configuration file. See [Roo Code MCP docs](https://docs.roocode.com/features/mcp/using-mcp-in-roo) for more info.+[<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Context7%20MCP&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)+[<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Context7%20MCP&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)-#### Roo Code Remote Server Connection+Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.++#### VS Code Remote Server Connection```json-{- "mcpServers": {+"mcp": {+ "servers": {"context7": {- "type": "streamable-http",+ "type": "http","url": "https://mcp.context7.com/mcp"}}}```-#### Roo Code Local Server Connection+#### VS Code Local Server Connection```json-{- "mcpServers": {+"mcp": {+ "servers": {"context7": {+ "type": "stdio","command": "npx","args": ["-y", "@upstash/context7-mcp"]}@@ -479,67 +447,104 @@ Add this to your Roo Code MCP configuration file. See [Roo Code MCP docs](https:</details><details>-<summary><b>Install in Zencoder</b></summary>--To configure Context7 MCP in Zencoder, follow these steps:+<summary><b>Install in Windows</b></summary>-1. Go to the Zencoder menu (...)-2. From the dropdown menu, select Agent tools-3. Click on the Add custom MCP-4. Add the name and server configuration from below, and make sure to hit the Install button+The configuration on Windows is slightly different compared to Linux or macOS (_`Cline` is used in the example_). The same principle applies to other editors; refer to the configuration of `command` and `args`.```json{- "command": "npx",- "args": [- "-y",- "@upstash/context7-mcp@latest"- ]+ "mcpServers": {+ "github.com/upstash/context7-mcp": {+ "command": "cmd",+ "args": ["/c", "npx", "-y", "@upstash/context7-mcp@latest"],+ "disabled": false,+ "autoApprove": []+ }+ }}```-Once the MCP server is added, you can easily continue using it.-</details><details>-<summary><b>Install in Amazon Q Developer CLI</b></summary>+<summary><b>Install in Windsurf</b></summary>-Add this to your Amazon Q Developer CLI configuration file. See [Amazon Q Developer CLI docs](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html) for more details.+Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/mcp) for more info.++#### Windsurf Remote Server Connection++```json+{+ "mcpServers": {+ "context7": {+ "serverUrl": "https://mcp.context7.com/sse"+ }+ }+}+```++#### Windsurf Local Server Connection```json{"mcpServers": {"context7": {"command": "npx",- "args": ["-y", "@upstash/context7-mcp@latest"]+ "args": ["-y", "@upstash/context7-mcp"]}}}```+</details><details>-<summary><b>Install in Qodo Gen</b></summary>--See [Qodo Gen docs](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps) for more details.+<summary><b>Install in Zed</b></summary>-1. Open Qodo Gen chat panel in VSCode or IntelliJ.-2. Click Connect more tools.-3. Click + Add new MCP.-4. Add the following configuration:+It can be installed via [Zed Extensions](https://zed.dev/extensions?query=Context7) or you can add this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.```json{- "mcpServers": {- "context7": {- "url": "https://mcp.context7.com/mcp"+ "context_servers": {+ "Context7": {+ "command": {+ "path": "npx",+ "args": ["-y", "@upstash/context7-mcp"]+ },+ "settings": {}}}}```+</details>+<details>+<summary><b>Install in Zencoder</b></summary>++To configure Context7 MCP in Zencoder, follow these steps:++1. Go to the Zencoder menu (...)+2. From the dropdown menu, select Agent tools+3. Click on the Add custom MCP+4. Add the name and server configuration from below, and make sure to hit the Install button++```json+{+ "command": "npx",+ "args": [+ "-y",+ "@upstash/context7-mcp@latest"+ ]+}+```++Once the MCP server is added, you can easily continue using it.++</details>+++## 🔨 Available ToolsContext7 MCP provides the following tools that LLMs can use: