This is page 2 of 2. Use http://codebase.md/upstash/context7-mcp?lines=false&page={x} to view the full context.
# Directory Structure
```
├── .github
│ ├── dependabot.yml
│ ├── ISSUE_TEMPLATE
│ │ ├── bug_report.yml
│ │ ├── documentation.yml
│ │ └── feature_request.yml
│ └── workflows
│ ├── check.yaml
│ ├── publish-mcp.yml
│ └── release.yml
├── .gitignore
├── bun.lock
├── Dockerfile
├── docs
│ ├── adding-projects.md
│ ├── README.ar.md
│ ├── README.de.md
│ ├── README.es.md
│ ├── README.fr.md
│ ├── README.id-ID.md
│ ├── README.it.md
│ ├── README.ja.md
│ ├── README.ko.md
│ ├── README.pt-BR.md
│ ├── README.ru.md
│ ├── README.tr.md
│ ├── README.uk.md
│ ├── README.vi.md
│ ├── README.zh-CN.md
│ └── README.zh-TW.md
├── eslint.config.js
├── gemini-extension.json
├── LICENSE
├── mcpb
│ ├── .mcpbignore
│ ├── context7.mcpb
│ └── manifest.json
├── package.json
├── prettier.config.mjs
├── public
│ ├── context7-icon-green.svg
│ ├── context7-icon.svg
│ ├── context7-logo.svg
│ ├── cover.png
│ └── icon.png
├── README.md
├── schema
│ └── context7.json
├── server.json
├── smithery.yaml
├── src
│ ├── index.ts
│ └── lib
│ ├── api.ts
│ ├── encryption.ts
│ ├── types.ts
│ └── utils.ts
└── tsconfig.json
```
# Files
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
```markdown
[](https://cursor.com/en/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D) [<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/Install%20in%20VS%20Code-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white">](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)
# Context7 MCP - Up-to-date Code Docs For Any Prompt
[](https://context7.com) [](https://smithery.ai/server/@upstash/context7-mcp) [](https://www.npmjs.com/package/@upstash/context7-mcp) [](./LICENSE)
[](./docs/README.zh-TW.md) [](./docs/README.zh-CN.md) [](./docs/README.ja.md) [](./docs/README.ko.md) [](./docs/README.es.md) [](./docs/README.fr.md) [-purple>)](./docs/README.pt-BR.md) [](./docs/README.it.md) [](./docs/README.id-ID.md) [](./docs/README.de.md) [](./docs/README.ru.md) [](./docs/README.uk.md) [](./docs/README.tr.md) [](./docs/README.ar.md) [](./docs/README.vi.md)
## ❌ Without Context7
LLMs rely on outdated or generic information about the libraries you use. You get:
- ❌ Code examples are outdated and based on year-old training data
- ❌ Hallucinated APIs that don't even exist
- ❌ Generic answers for old package versions
## ✅ With Context7
Context7 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.
> [!NOTE]
> This repository hosts the source code of Context7 MCP server. The supporting components — API backend, parsing engine, and crawling engine — are private and not part of this release.
## 📚 Adding Projects
Check out our [project addition guide](./docs/adding-projects.md) to learn how to add (or update) your favorite libraries to Context7.
## 🛠️ Installation
### Requirements
- Node.js >= v18.0.0
- Cursor, Claude Code, VSCode, Windsurf or another MCP Client
- Context7 API Key (Optional) for higher rate limits and private repositories (Get yours by creating an account at [context7.com/dashboard](https://context7.com/dashboard))
<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
[](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"
}
}
}
}
```
#### Cursor Local Server Connection
[](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"]
}
}
}
```
</details>
<details>
<summary><b>Install in Claude Code</b></summary>
Run this command. See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp) for more info.
#### Claude Code Remote Server Connection
```sh
claude mcp add --transport http context7 https://mcp.context7.com/mcp --header "CONTEXT7_API_KEY: YOUR_API_KEY"
```
#### Claude Code Local Server Connection
```sh
claude mcp add context7 -- npx -y @upstash/context7-mcp --api-key YOUR_API_KEY
```
</details>
<details>
<summary><b>Install in Amp</b></summary>
Run this command in your terminal. See [Amp MCP docs](https://ampcode.com/manual#mcp) for more info.
#### Without API Key (Basic Usage)
```sh
amp mcp add context7 https://mcp.context7.com/mcp
```
#### With API Key (Higher Rate Limits & Private Repos)
```sh
amp mcp add context7 --header "CONTEXT7_API_KEY=YOUR_API_KEY" https://mcp.context7.com/mcp
```
</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/cascade/mcp) for more info.
#### Windsurf Remote Server Connection
```json
{
"mcpServers": {
"context7": {
"serverUrl": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
#### Windsurf Local Server Connection
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Install in VS 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)
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
"mcp": {
"servers": {
"context7": {
"type": "http",
"url": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
#### VS Code Local Server Connection
```json
"mcp": {
"servers": {
"context7": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary>
<b>Install in Cline</b>
</summary>
You can easily install Context7 through the [Cline MCP Server Marketplace](https://cline.bot/mcp-marketplace) by following these instructions:
1. Open **Cline**.
2. Click the hamburger menu icon (☰) to enter the **MCP Servers** section.
3. Use the search bar within the **Marketplace** tab to find _Context7_.
4. Click the **Install** button.
Or you can directly edit MCP servers configuration:
1. Open **Cline**.
2. Click the hamburger menu icon (☰) to enter the **MCP Servers** section.
3. Choose **Remote Servers** tab.
4. Click the **Edit Configuration** button.
5. Add context7 to `mcpServers`:
```json
{
"mcpServers": {
"context7": {
"url": "https://mcp.context7.com/mcp",
"type": "streamableHttp",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
}
}
```
</details>
<details>
<summary><b>Install in Zed</b></summary>
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
{
"context_servers": {
"Context7": {
"source": "custom",
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Install in Augment Code</b></summary>
To configure Context7 MCP in Augment Code, you can use either the graphical interface or manual configuration.
### **A. Using the Augment Code UI**
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:
```
npx -y @upstash/context7-mcp@latest
```
6. Name the MCP: **Context7**.
7. Click the **Add** button.
Once the MCP server is added, you can start using Context7's up-to-date code documentation features directly within Augment Code.
---
### **B. Manual Configuration**
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
```json
"augment.advanced": {
"mcpServers": [
{
"name": "context7",
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
]
}
```
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 Roo 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.
#### Roo Code Remote Server Connection
```json
{
"mcpServers": {
"context7": {
"type": "streamable-http",
"url": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
#### Roo Code Local Server Connection
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Install in Gemini CLI</b></summary>
See [Gemini CLI Configuration](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html) for details.
1. Open the Gemini CLI settings file. The location is `~/.gemini/settings.json` (where `~` is your home directory).
2. Add the following to the `mcpServers` object in your `settings.json` file:
```json
{
"mcpServers": {
"context7": {
"httpUrl": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY",
"Accept": "application/json, text/event-stream"
}
}
}
}
```
Or, for a 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.
</details>
<details>
<summary><b>Install in Qwen Coder</b></summary>
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:
```json
{
"mcpServers": {
"context7": {
"httpUrl": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY",
"Accept": "application/json, text/event-stream"
}
}
}
}
```
Or, for a 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.
</details>
<details>
<summary><b>Install in Claude Desktop</b></summary>
#### Remote Server Connection
Open Claude Desktop and navigate to Settings > Connectors > Add Custom Connector. Enter the name as `Context7` and the remote MCP server URL as `https://mcp.context7.com/mcp`.
#### Local Server Connection
Open Claude Desktop developer settings and edit your `claude_desktop_config.json` file to add the following configuration. See [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Install in Opencode</b></summary>
Add this to your Opencode configuration file. See [Opencode MCP docs](https://opencode.ai/docs/mcp-servers) for more info.
#### Opencode Remote Server Connection
```json
"mcp": {
"context7": {
"type": "remote",
"url": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
},
"enabled": true
}
}
```
#### Opencode Local Server Connection
```json
{
"mcp": {
"context7": {
"type": "local",
"command": ["npx", "-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
"enabled": true
}
}
}
```
</details>
<details>
<summary><b>Install in OpenAI Codex</b></summary>
See [OpenAI Codex](https://github.com/openai/codex) for more information.
Add the following configuration to your OpenAI Codex MCP server settings:
#### Local Server Connection
```toml
[mcp_servers.context7]
args = ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
command = "npx"
startup_timeout_ms = 20_000
```
#### Remote Server Connection
```toml
[mcp_servers.context7]
url = "https://mcp.context7.com/mcp"
http_headers = { "CONTEXT7_API_KEY" = "YOUR_API_KEY" }
```
> Optional troubleshooting — only if you see startup "request timed out" or "not found program". Most users can ignore this.
>
> - First try: increase `startup_timeout_ms` to `40_000` and retry.
> - Windows quick fix (absolute `npx` path + explicit env):
>
> ```toml
> [mcp_servers.context7]
> command = "C:\\Users\\yourname\\AppData\\Roaming\\npm\\npx.cmd"
> args = [
> "-y",
> "@upstash/context7-mcp",
> "--api-key",
> "YOUR_API_KEY"
> ]
> env = { SystemRoot="C:\\Windows", APPDATA="C:\\Users\\yourname\\AppData\\Roaming" }
> startup_timeout_ms = 40_000
> ```
>
> - macOS quick fix (use Node + installed package entry point):
>
> ```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"
> ]
> ```
>
> Notes: Replace `yourname` with your OS username. Explicitly setting `APPDATA` and `SystemRoot` is essential because these are required by `npx` on Windows but not set by certain versions of OpenAI Codex mcp clients by default.
</details>
<details>
<summary><b>Install in JetBrains AI Assistant</b></summary>
See [JetBrains AI Assistant Documentation](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html) for more details.
1. In JetBrains IDEs, go to `Settings` -> `Tools` -> `AI Assistant` -> `Model Context Protocol (MCP)`
2. Click `+ Add`.
3. Click on `Command` in the top-left corner of the dialog and select the As JSON option from the list
4. Add this configuration and click `OK`
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
5. Click `Apply` to save changes.
6. The same way context7 could be added for JetBrains Junie in `Settings` -> `Tools` -> `Junie` -> `MCP Settings`
</details>
<details>
<summary><b>Install in Kiro</b></summary>
See [Kiro Model Context Protocol Documentation](https://kiro.dev/docs/mcp/configuration/) for details.
1. Navigate `Kiro` > `MCP Servers`
2. Add a new MCP server by clicking the `+ Add` button.
3. Paste the configuration given below:
```json
{
"mcpServers": {
"Context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
"env": {},
"disabled": false,
"autoApprove": []
}
}
}
```
4. Click `Save` to apply the changes.
</details>
<details>
<summary><b>Install in Trae</b></summary>
Use the Add manually feature and fill in the JSON configuration information for that MCP server.
For more details, visit the [Trae documentation](https://docs.trae.ai/ide/model-context-protocol?_lang=en).
#### Trae Remote Server Connection
```json
{
"mcpServers": {
"context7": {
"url": "https://mcp.context7.com/mcp"
}
}
}
```
#### Trae Local Server Connection
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Using Bun or Deno</b></summary>
Use these alternatives to run the local Context7 MCP server with other runtimes. These examples work for any client that supports launching a local MCP server via command + args.
#### Bun
```json
{
"mcpServers": {
"context7": {
"command": "bunx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
#### Deno
```json
{
"mcpServers": {
"context7": {
"command": "deno",
"args": [
"run",
"--allow-env=NO_DEPRECATION,TRACE_DEPRECATION",
"--allow-net",
"npm:@upstash/context7-mcp"
]
}
}
}
```
</details>
<details>
<summary><b>Using Docker</b></summary>
If you prefer to run the MCP server in a Docker container:
1. **Build the Docker Image:**
First, create a `Dockerfile` in the project root (or anywhere you prefer):
<details>
<summary>Click to see Dockerfile content</summary>
```Dockerfile
FROM node:18-alpine
WORKDIR /app
# Install the latest version globally
RUN npm install -g @upstash/context7-mcp
# Expose default port if needed (optional, depends on MCP client interaction)
# EXPOSE 3000
# Default command to run the server
CMD ["context7-mcp"]
```
</details>
Then, build the image using a tag (e.g., `context7-mcp`). **Make sure Docker Desktop (or the Docker daemon) is running.** Run the following command in the same directory where you saved the `Dockerfile`:
```bash
docker build -t context7-mcp .
```
2. **Configure Your MCP Client:**
Update your MCP client's configuration to use the Docker command.
_Example for a cline_mcp_settings.json:_
```json
{
"mcpServers": {
"Сontext7": {
"autoApprove": [],
"disabled": false,
"timeout": 60,
"command": "docker",
"args": ["run", "-i", "--rm", "context7-mcp"],
"transportType": "stdio"
}
}
}
```
_Note: This is an example configuration. Please refer to the specific examples for your MCP client (like Cursor, VS Code, etc.) earlier in this README to adapt the structure (e.g., `mcpServers` vs `servers`). Also, ensure the image name in `args` matches the tag used during the `docker build` command._
</details>
<details>
<summary><b>Install Using the Desktop Extension</b></summary>
Install the [context7.mcpb](mcpb/context7.mcpb) file under the mcpb folder and add it to your client. For more information, please check out [MCP bundles docs](https://github.com/anthropics/mcpb#mcp-bundles-mcpb).
</details>
<details>
<summary><b>Install in Windows</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`.
```json
{
"mcpServers": {
"github.com/upstash/context7-mcp": {
"command": "cmd",
"args": ["/c", "npx", "-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
"disabled": false,
"autoApprove": []
}
}
}
```
</details>
<details>
<summary><b>Install in Amazon Q Developer CLI</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.
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Install in Warp</b></summary>
See [Warp Model Context Protocol Documentation](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server) for details.
1. Navigate `Settings` > `AI` > `Manage MCP servers`.
2. Add a new MCP server by clicking the `+ Add` button.
3. Paste the configuration given below:
```json
{
"Context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
"env": {},
"working_directory": null,
"start_on_launch": true
}
}
```
4. Click `Save` to apply the changes.
</details>
<details>
<summary><b>Install in Copilot Coding Agent</b></summary>
## Using Context7 with Copilot Coding Agent
Add the following configuration to the `mcp` section of your Copilot Coding Agent configuration file 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"]
}
}
}
```
For more information, see the [official GitHub documentation](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp).
</details>
<details>
<summary><b>Install in Copilot CLI</b></summary>
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:
```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"
]
}
}
}
```
Or, for a 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.
</details>
<details>
<summary><b>Install in LM Studio</b></summary>
See [LM Studio MCP Support](https://lmstudio.ai/blog/lmstudio-v0.3.17) for more information.
#### One-click install:
[](https://lmstudio.ai/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB1cHN0YXNoL2NvbnRleHQ3LW1jcCJdfQ%3D%3D)
#### Manual set-up:
1. Navigate to `Program` (right side) > `Install` > `Edit mcp.json`.
2. Paste the configuration given below:
```json
{
"mcpServers": {
"Context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
3. Click `Save` to apply the changes.
4. Toggle the MCP server on/off from the right hand side, under `Program`, or by clicking the plug icon at the bottom of the chat box.
</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
{
"inputs": [],
"servers": {
"context7": {
"type": "http",
"url": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
Or, for a local server:
```json
{
"mcp": {
"servers": {
"context7": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
}
```
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 Crush</b></summary>
Add this to your Crush configuration file. See [Crush MCP docs](https://github.com/charmbracelet/crush#mcps) for more info.
#### Crush Remote Server Connection (HTTP)
```json
{
"$schema": "https://charm.land/crush.json",
"mcp": {
"context7": {
"type": "http",
"url": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
#### Crush Local Server Connection
```json
{
"$schema": "https://charm.land/crush.json",
"mcp": {
"context7": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Install in BoltAI</b></summary>
Open the "Settings" page of the app, navigate to "Plugins," and enter the following JSON:
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
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 Rovo Dev CLI</b></summary>
Edit your Rovo Dev CLI MCP config by running the command below -
```bash
acli rovodev mcp
```
Example config -
#### Remote Server Connection
```json
{
"mcpServers": {
"context7": {
"url": "https://mcp.context7.com/mcp"
}
}
}
```
#### Local Server Connection
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</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", "--api-key", "YOUR_API_KEY"]
}
```
Once the MCP server is added, you can easily continue using it.
</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.
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:
#### Qodo Gen Local Server Connection
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}
```
#### Qodo Gen Remote Server Connection
```json
{
"mcpServers": {
"context7": {
"url": "https://mcp.context7.com/mcp"
}
}
}
```
</details>
<details>
<summary><b>Install in Perplexity Desktop</b></summary>
See [Local and Remote MCPs for Perplexity](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity) for more information.
1. Navigate `Perplexity` > `Settings`
2. Select `Connectors`.
3. Click `Add Connector`.
4. Select `Advanced`.
5. Enter Server Name: `Context7`
6. Paste the following JSON in the text area:
```json
{
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
"command": "npx",
"env": {}
}
```
7. Click `Save`.
</details>
<details>
<summary><b>Install in Factory</b></summary>
Factory's droid supports MCP servers through its CLI. See [Factory MCP docs](https://docs.factory.ai/cli/configuration/mcp) for more info.
#### Factory 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
```
#### Factory 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.
</details>
## 🔨 Available Tools
Context7 MCP provides the following tools that LLMs can use:
- `resolve-library-id`: Resolves a general library name into a Context7-compatible library ID.
- `libraryName` (required): The name of the library to search for
- `get-library-docs`: Fetches documentation for a library using a Context7-compatible library ID.
- `context7CompatibleLibraryID` (required): Exact Context7-compatible library ID (e.g., `/mongodb/docs`, `/vercel/next.js`)
- `topic` (optional): Focus the docs on a specific topic (e.g., "routing", "hooks")
- `tokens` (optional, default 5000): Max number of tokens to return. Values less than 1000 are automatically increased to 1000.
## 🛟 Tips
### Add a Rule
If you don’t want to add `use context7` to every prompt, you can define a simple rule in your MCP client's rule section:
- For Windsurf, in `.windsurfrules` file
- For Cursor, from `Cursor Settings > Rules` section
- For Claude Code, in `CLAUDE.md` file
Or the equivalent in your MCP client to auto-invoke Context7 on any code question.
#### Example Rule
```txt
Always use context7 when I need code generation, setup or configuration steps, or
library/API documentation. This means you should automatically use the Context7 MCP
tools to resolve library id and get library docs without me having to explicitly ask.
```
From then on, you’ll get Context7’s docs in any related conversation without typing anything extra. You can alter the rule to match your use cases.
### Use Library Id
If you already know exactly which library you want to use, add its Context7 ID to your prompt. That way, Context7 MCP server can skip the library-matching step and directly continue with retrieving docs.
```txt
Implement basic authentication with Supabase. use library /supabase/supabase for API and docs.
```
The slash syntax tells the MCP tool exactly which library to load docs for.
### HTTPS Proxy
If you are behind an HTTP proxy, Context7 uses the standard `https_proxy` / `HTTPS_PROXY` environment variables.
## 💻 Development
Clone the project and install dependencies:
```bash
bun i
```
Build:
```bash
bun run build
```
Run the server:
```bash
bun run dist/index.js
```
### CLI Arguments
`context7-mcp` accepts the following CLI flags:
- `--transport <stdio|http>` – Transport to use (`stdio` by default). Use `http` for remote HTTP server or `stdio` for local integration.
- `--port <number>` – Port to listen on when using `http` transport (default `3000`).
- `--api-key <key>` – API key for authentication (or set `CONTEXT7_API_KEY` env var). You can get your API key by creating an account at [context7.com/dashboard](https://context7.com/dashboard).
Example with HTTP transport and port 8080:
```bash
bun run dist/index.js --transport http --port 8080
```
Another example with stdio transport:
```bash
bun run dist/index.js --transport stdio --api-key YOUR_API_KEY
```
### Environment Variables
You can use the `CONTEXT7_API_KEY` environment variable instead of passing the `--api-key` flag. This is useful for:
- Storing API keys securely in `.env` files
- Integration with MCP server setups that use dotenv
- Tools that prefer environment variable configuration
**Note:** The `--api-key` CLI flag takes precedence over the environment variable when both are provided.
**Example with .env file:**
```bash
# .env
CONTEXT7_API_KEY=your_api_key_here
```
**Example MCP configuration using environment variable:**
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp"],
"env": {
"CONTEXT7_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
<details>
<summary><b>Local Configuration Example</b></summary>
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["tsx", "/path/to/folder/context7/src/index.ts", "--api-key", "YOUR_API_KEY"]
}
}
}
```
</details>
<details>
<summary><b>Testing with MCP Inspector</b></summary>
```bash
npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp
```
</details>
## 🚨 Troubleshooting
<details>
<summary><b>Module Not Found Errors</b></summary>
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.
</details>
<details>
<summary><b>ESM Resolution Issues</b></summary>
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]"]
}
}
}
```
</details>
<details>
<summary><b>TLS/Certificate Issues</b></summary>
Use the `--experimental-fetch` flag to bypass TLS-related problems:
```json
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "--node-options=--experimental-fetch", "@upstash/context7-mcp"]
}
}
}
```
</details>
<details>
<summary><b>General MCP Client Errors</b></summary>
1. Try adding `@latest` to the package name
2. Use `bunx` as an alternative to `npx`
3. Consider using `deno` as another alternative
4. Ensure you're using Node.js v18 or higher for native fetch support
</details>
## ⚠️ Disclaimer
1- Context7 projects are community-contributed and while we strive to maintain high quality, we cannot guarantee the accuracy, completeness, or security of all library documentation. Projects listed in Context7 are developed and maintained by their respective owners, not by Context7. If you encounter any suspicious, inappropriate, or potentially harmful content, please use the "Report" button on the project page to notify us immediately. We take all reports seriously and will review flagged content promptly to maintain the integrity and safety of our platform. By using Context7, you acknowledge that you do so at your own discretion and risk.
2- This repository hosts the MCP server’s source code. The supporting components — API backend, parsing engine, and crawling engine — are private and not part of this release.
## 🤝 Connect with Us
Stay updated and join our community:
- 📢 Follow us on [X](https://x.com/context7ai) for the latest news and updates
- 🌐 Visit our [Website](https://context7.com)
- 💬 Join our [Discord Community](https://upstash.com/discord)
## 📺 Context7 In Media
- [Better Stack: "Free Tool Makes Cursor 10x Smarter"](https://youtu.be/52FC3qObp9E)
- [Cole Medin: "This is Hands Down the BEST MCP Server for AI Coding Assistants"](https://www.youtube.com/watch?v=G7gK8H6u7Rs)
- [Income Stream Surfers: "Context7 + SequentialThinking MCPs: Is This AGI?"](https://www.youtube.com/watch?v=-ggvzyLpK6o)
- [Julian Goldie SEO: "Context7: New MCP AI Agent Update"](https://www.youtube.com/watch?v=CTZm6fBYisc)
- [JeredBlu: "Context 7 MCP: Get Documentation Instantly + VS Code Setup"](https://www.youtube.com/watch?v=-ls0D-rtET4)
- [Income Stream Surfers: "Context7: The New MCP Server That Will CHANGE AI Coding"](https://www.youtube.com/watch?v=PS-2Azb-C3M)
- [AICodeKing: "Context7 + Cline & RooCode: This MCP Server Makes CLINE 100X MORE EFFECTIVE!"](https://www.youtube.com/watch?v=qZfENAPMnyo)
- [Sean Kochel: "5 MCP Servers For Vibe Coding Glory (Just Plug-In & Go)"](https://www.youtube.com/watch?v=LqTQi8qexJM)
## ⭐ Star History
[](https://www.star-history.com/#upstash/context7&Date)
## 📄 License
MIT
```
--------------------------------------------------------------------------------
/prettier.config.mjs:
--------------------------------------------------------------------------------
```
/**
* @type {import('prettier').Config}
*/
const config = {
endOfLine: "lf",
singleQuote: false,
tabWidth: 2,
trailingComma: "es5",
printWidth: 100,
arrowParens: "always",
};
export default config;
```
--------------------------------------------------------------------------------
/gemini-extension.json:
--------------------------------------------------------------------------------
```json
{
"name": "context7",
"description": "Up-to-date code docs for any prompt",
"version": "1.0.0",
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp", "--api-key", "${CONTEXT7_API_KEY}"]
}
}
}
```
--------------------------------------------------------------------------------
/smithery.yaml:
--------------------------------------------------------------------------------
```yaml
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
startCommand:
type: http
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
description: No configuration required
exampleConfig: {}
```
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
```json
{
"compilerOptions": {
"target": "ES2022",
"module": "Node16",
"moduleResolution": "Node16",
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
```
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
```yaml
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: monthly
- package-ecosystem: bun
directory: /
schedule:
interval: monthly
- package-ecosystem: docker
directory: /
schedule:
interval: monthly
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
```
--------------------------------------------------------------------------------
/src/lib/types.ts:
--------------------------------------------------------------------------------
```typescript
export interface SearchResult {
id: string;
title: string;
description: string;
branch: string;
lastUpdateDate: string;
state: DocumentState;
totalTokens: number;
totalSnippets: number;
totalPages: number;
stars?: number;
trustScore?: number;
versions?: string[];
}
export interface SearchResponse {
error?: string;
results: SearchResult[];
}
// Version state is still needed for validating search results
export type DocumentState = "initial" | "finalized" | "error" | "delete";
```
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
```dockerfile
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
# ----- Build Stage -----
FROM node:lts-alpine AS builder
WORKDIR /app
# Copy package and configuration
COPY package.json bun.lock tsconfig.json ./
# Copy source code
COPY src ./src
# Install dependencies and build
RUN npm install && npm run build
# ----- Production Stage -----
FROM node:lts-alpine
WORKDIR /app
# Copy built artifacts
COPY --from=builder /app/dist ./dist
# Copy package.json for production install
COPY package.json ./
# Install only production dependencies
RUN npm install --production --ignore-scripts
# Expose HTTP port
EXPOSE 8080
# Default command using CLI flags
CMD ["node", "dist/index.js", "--transport", "http", "--port", "8080"]
```
--------------------------------------------------------------------------------
/server.json:
--------------------------------------------------------------------------------
```json
{
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json",
"name": "io.github.upstash/context7",
"title": "Context7",
"description": "Up-to-date code docs for any prompt",
"repository": {
"url": "https://github.com/upstash/context7",
"source": "github"
},
"version": "1.0.0",
"packages": [
{
"registryType": "npm",
"identifier": "@upstash/context7-mcp",
"version": "1.0.26",
"transport": {
"type": "stdio"
},
"environmentVariables": [
{
"description": "API key for authentication",
"isRequired": false,
"format": "string",
"isSecret": true,
"name": "CONTEXT7_API_KEY"
}
]
}
]
}
```
--------------------------------------------------------------------------------
/.github/workflows/check.yaml:
--------------------------------------------------------------------------------
```yaml
name: Build Check
on:
push:
branches: [master]
pull_request:
branches: [master]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- name: Cache dependencies
uses: actions/cache@v4
with:
path: ~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
restore-keys: |
${{ runner.os }}-bun-
- name: Install dependencies
run: bun install --frozen-lockfile
- name: Run linter
run: bun run lint:check
- name: Check formatting
run: bun run format --check
- name: Build project
run: bun run build
```
--------------------------------------------------------------------------------
/eslint.config.js:
--------------------------------------------------------------------------------
```javascript
import tseslint from "typescript-eslint";
import eslintPluginPrettier from "eslint-plugin-prettier";
export default tseslint.config({
// Base ESLint configuration
ignores: ["node_modules/**", "build/**", "dist/**", ".git/**", ".github/**"],
languageOptions: {
ecmaVersion: 2020,
sourceType: "module",
parser: tseslint.parser,
parserOptions: {},
globals: {
// Add Node.js globals
process: "readonly",
require: "readonly",
module: "writable",
console: "readonly",
},
},
// Settings for all files
linterOptions: {
reportUnusedDisableDirectives: true,
},
// Apply ESLint recommended rules
extends: [tseslint.configs.recommended],
plugins: {
prettier: eslintPluginPrettier,
},
rules: {
// TypeScript rules
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
"@typescript-eslint/no-explicit-any": "warn",
// Prettier integration
"prettier/prettier": "error",
},
});
```
--------------------------------------------------------------------------------
/public/context7-icon.svg:
--------------------------------------------------------------------------------
```
<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
<rect width="28" height="28" rx="4" fill="black" style="fill:black;fill-opacity:1;"/>
<path d="M10.5724 15.2565C10.5724 17.5025 9.6613 19.3778 8.17805 21.1047H11.6319L11.6319 22.7786H6.33459V21.1895C7.95557 19.3566 8.58065 17.8628 8.58065 15.2565L10.5724 15.2565Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M17.4276 15.2565C17.4276 17.5025 18.3387 19.3778 19.822 21.1047H16.3681V22.7786H21.6654V21.1895C20.0444 19.3566 19.4194 17.8628 19.4194 15.2565H17.4276Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M10.5724 12.7435C10.5724 10.4975 9.66131 8.62224 8.17807 6.89532L11.6319 6.89532V5.22137L6.33461 5.22137V6.81056C7.95558 8.64343 8.58066 10.1373 8.58066 12.7435L10.5724 12.7435Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M17.4276 12.7435C17.4276 10.4975 18.3387 8.62224 19.822 6.89532L16.3681 6.89532L16.3681 5.22138L21.6654 5.22138V6.81056C20.0444 8.64343 19.4194 10.1373 19.4194 12.7435H17.4276Z" fill="white" style="fill:white;fill-opacity:1;"/>
</svg>
```
--------------------------------------------------------------------------------
/public/context7-icon-green.svg:
--------------------------------------------------------------------------------
```
<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
<rect width="28" height="28" rx="4" fill="#059669" style="fill:#059669;fill:color(display-p3 0.0196 0.5882 0.4118);fill-opacity:1;"/>
<path d="M10.5724 15.2565C10.5724 17.5025 9.6613 19.3778 8.17805 21.1047H11.6319L11.6319 22.7786H6.33459V21.1895C7.95557 19.3566 8.58065 17.8628 8.58065 15.2565L10.5724 15.2565Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M17.4276 15.2565C17.4276 17.5025 18.3387 19.3778 19.822 21.1047H16.3681V22.7786H21.6654V21.1895C20.0444 19.3566 19.4194 17.8628 19.4194 15.2565H17.4276Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M10.5724 12.7435C10.5724 10.4975 9.66131 8.62224 8.17807 6.89532L11.6319 6.89532V5.22137L6.33461 5.22137V6.81056C7.95558 8.64343 8.58066 10.1373 8.58066 12.7435L10.5724 12.7435Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M17.4276 12.7435C17.4276 10.4975 18.3387 8.62224 19.822 6.89532L16.3681 6.89532L16.3681 5.22138L21.6654 5.22138V6.81056C20.0444 8.64343 19.4194 10.1373 19.4194 12.7435H17.4276Z" fill="white" style="fill:white;fill-opacity:1;"/>
</svg>
```
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/documentation.yml:
--------------------------------------------------------------------------------
```yaml
name: Documentation Issue
description: Report incorrect or missing documentation
title: "[Docs]: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Found an issue with Context7 documentation? Let us know!
- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: Where is the issue?
options:
- README
- Installation instructions
- API documentation
- Library-specific docs
- Configuration examples
validations:
required: true
- type: textarea
id: issue
attributes:
label: Issue Description
description: What's wrong or missing?
validations:
required: true
- type: input
id: location
attributes:
label: Documentation Location
description: Link or section name where the issue exists
placeholder: e.g., README.md line 45, or "Installation via Smithery" section
- type: textarea
id: suggestion
attributes:
label: Suggested Fix
description: How should it be corrected or what should be added?
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other relevant information
```
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.yml:
--------------------------------------------------------------------------------
```yaml
name: Feature Request
description: Suggest a new feature or improvement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! We appreciate your input.
- type: textarea
id: problem
attributes:
label: Problem Description
description: Is your feature request related to a problem? Please describe.
placeholder: I'm frustrated when...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like
placeholder: I would like Context7 to...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Describe any alternative solutions or features you've considered
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Nice to have
- Would improve my workflow
- Blocking my usage
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context, screenshots, or examples about the feature request
```
--------------------------------------------------------------------------------
/src/lib/encryption.ts:
--------------------------------------------------------------------------------
```typescript
import { createCipheriv, randomBytes } from "crypto";
const ENCRYPTION_KEY =
process.env.CLIENT_IP_ENCRYPTION_KEY ||
"000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f";
const ALGORITHM = "aes-256-cbc";
function validateEncryptionKey(key: string): boolean {
// Must be exactly 64 hex characters (32 bytes)
return /^[0-9a-fA-F]{64}$/.test(key);
}
function encryptClientIp(clientIp: string): string {
if (!validateEncryptionKey(ENCRYPTION_KEY)) {
console.error("Invalid encryption key format. Must be 64 hex characters.");
return clientIp; // Fallback to unencrypted
}
try {
const iv = randomBytes(16);
const cipher = createCipheriv(ALGORITHM, Buffer.from(ENCRYPTION_KEY, "hex"), iv);
let encrypted = cipher.update(clientIp, "utf8", "hex");
encrypted += cipher.final("hex");
return iv.toString("hex") + ":" + encrypted;
} catch (error) {
console.error("Error encrypting client IP:", error);
return clientIp; // Fallback to unencrypted
}
}
export function generateHeaders(
clientIp?: string,
apiKey?: string,
extraHeaders: Record<string, string> = {}
): Record<string, string> {
const headers: Record<string, string> = { ...extraHeaders };
if (clientIp) {
headers["mcp-client-ip"] = encryptClientIp(clientIp);
}
if (apiKey) {
headers["Authorization"] = `Bearer ${apiKey}`;
}
return headers;
}
```
--------------------------------------------------------------------------------
/mcpb/manifest.json:
--------------------------------------------------------------------------------
```json
{
"dxt_version": "0.1",
"name": "context7",
"display_name": "Context7",
"version": "1.0.1",
"description": "Up-to-date Code Docs For Any Prompt",
"long_description": "Context7 MCP pulls up-to-date, version-specific documentation and code examples straight from the source — and places them directly into your prompt.",
"author": {
"name": "Upstash",
"email": "[email protected]",
"url": "https://upstash.com"
},
"homepage": "https://context7.com",
"documentation": "https://github.com/upstash/context7",
"icon": "icon.png",
"server": {
"type": "node",
"entry_point": "dist/index.js",
"mcp_config": {
"command": "node",
"args": ["${__dirname}/dist/index.js"],
"env": {}
}
},
"tools": [
{
"name": "Resolve Context7 Library ID",
"description": "Resolves a package/product name to a Context7-compatible library ID and returns a list of matching libraries."
},
{
"name": "Get Library Docs",
"description": "Fetches up-to-date documentation for a library."
}
],
"compatibility": {
"platforms": ["darwin", "win32", "linux"],
"runtimes": {
"node": ">=v18.0.0"
}
},
"keywords": ["vibe-coding", "developer tools", "documentation", "context"],
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/upstash/context7.git"
}
}
```
--------------------------------------------------------------------------------
/.github/workflows/publish-mcp.yml:
--------------------------------------------------------------------------------
```yaml
name: Publish to MCP Registry
on:
workflow_dispatch:
inputs:
version:
description: "Version to publish (defaults to package.json version)"
required: false
type: string
jobs:
publish-mcp:
name: Publish to MCP Registry
runs-on: ubuntu-latest
permissions:
id-token: write # Required for OIDC authentication with MCP Registry
contents: read
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: lts/*
- name: Set version
run: |
if [ -n "${{ inputs.version }}" ]; then
VERSION="${{ inputs.version }}"
# Remove 'v' prefix if it exists
VERSION="${VERSION#v}"
else
VERSION=$(node -p "require('./package.json').version")
fi
echo "VERSION=$VERSION" >> $GITHUB_ENV
echo "Publishing version: $VERSION"
- name: Update package version in server.json
run: |
echo $(jq --arg v "${{ env.VERSION }}" '(.packages[0].version) = $v' server.json) > server.json
- name: Validate server.json
run: npx mcp-registry-validator validate server.json
- name: Install MCP Publisher
run: |
curl -L "https://github.com/modelcontextprotocol/registry/releases/download/v1.3.3/mcp-publisher_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher
- name: Login to MCP Registry
run: ./mcp-publisher login github-oidc
- name: Publish to MCP Registry
run: ./mcp-publisher publish
```
--------------------------------------------------------------------------------
/src/lib/utils.ts:
--------------------------------------------------------------------------------
```typescript
import { SearchResponse, SearchResult } from "./types.js";
/**
* Formats a search result into a human-readable string representation.
* Only shows code snippet count and GitHub stars when available (not equal to -1).
*
* @param result The SearchResult object to format
* @returns A formatted string with library information
*/
export function formatSearchResult(result: SearchResult): string {
// Always include these basic details
const formattedResult = [
`- Title: ${result.title}`,
`- Context7-compatible library ID: ${result.id}`,
`- Description: ${result.description}`,
];
// Only add code snippets count if it's a valid value
if (result.totalSnippets !== -1 && result.totalSnippets !== undefined) {
formattedResult.push(`- Code Snippets: ${result.totalSnippets}`);
}
// Only add trust score if it's a valid value
if (result.trustScore !== -1 && result.trustScore !== undefined) {
formattedResult.push(`- Trust Score: ${result.trustScore}`);
}
// Only add versions if it's a valid value
if (result.versions !== undefined && result.versions.length > 0) {
formattedResult.push(`- Versions: ${result.versions.join(", ")}`);
}
// Join all parts with newlines
return formattedResult.join("\n");
}
/**
* Formats a search response into a human-readable string representation.
* Each result is formatted using formatSearchResult.
*
* @param searchResponse The SearchResponse object to format
* @returns A formatted string with search results
*/
export function formatSearchResults(searchResponse: SearchResponse): string {
if (!searchResponse.results || searchResponse.results.length === 0) {
return "No documentation libraries found matching your query.";
}
const formattedResults = searchResponse.results.map(formatSearchResult);
return formattedResults.join("\n----------\n");
}
```
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
```json
{
"name": "@upstash/context7-mcp",
"version": "1.0.0",
"mcpName": "io.github.upstash/context7",
"description": "MCP server for Context7",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc && chmod 755 dist/index.js",
"format": "prettier --write .",
"lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
"lint:check": "eslint \"**/*.{js,ts,tsx}\"",
"start": "node dist/index.js --transport http",
"pack-mcpb": "bun install && bun run build && rm -rf node_modules && bun install --production && mv mcpb/.mcpbignore .mcpbignore && mv mcpb/manifest.json manifest.json && mv public/icon.png icon.png && mcpb validate manifest.json && mcpb pack . mcpb/context7.mcpb && mv manifest.json mcpb/manifest.json && mv .mcpbignore mcpb/.mcpbignore && mv icon.png public/icon.png && bun install"
},
"repository": {
"type": "git",
"url": "git+https://github.com/upstash/context7.git"
},
"keywords": [
"modelcontextprotocol",
"mcp",
"context7",
"vibe-coding",
"developer tools",
"documentation",
"context"
],
"author": "abdush",
"license": "MIT",
"type": "module",
"bin": {
"context7-mcp": "dist/index.js"
},
"files": [
"dist"
],
"bugs": {
"url": "https://github.com/upstash/context7/issues"
},
"homepage": "https://github.com/upstash/context7#readme",
"dependencies": {
"@modelcontextprotocol/sdk": "^1.17.5",
"@types/express": "^5.0.4",
"commander": "^14.0.0",
"express": "^5.1.0",
"undici": "^6.6.3",
"zod": "^3.24.2"
},
"devDependencies": {
"@types/node": "^22.13.14",
"@typescript-eslint/eslint-plugin": "^8.28.0",
"@typescript-eslint/parser": "^8.28.0",
"eslint": "^9.34.0",
"eslint-config-prettier": "^10.1.1",
"eslint-plugin-prettier": "^5.2.5",
"prettier": "^3.6.2",
"typescript": "^5.8.2",
"typescript-eslint": "^8.28.0"
}
}
```
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
```yaml
name: Release
on:
release:
types:
- published
jobs:
release:
name: Release
runs-on: ubuntu-latest
permissions:
id-token: write # Required for OIDC authentication with MCP Registry
contents: read
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Set env
run: |
VERSION="${GITHUB_REF##refs/*/}"
# Remove 'v' prefix if it exists
VERSION="${VERSION#v}"
echo "VERSION=$VERSION" >> $GITHUB_ENV
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: lts/*
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
- name: Set package version
run: |
echo $(jq --arg v "${{ env.VERSION }}" '(.version) = $v' package.json) > package.json
- name: Update version in source file
run: |
sed -i "s/version: \"[0-9]*\.[0-9]*\.[0-9]*\"/version: \"${{ env.VERSION }}\"/" src/index.ts
- name: Update package version in server.json
run: |
echo $(jq --arg v "${{ env.VERSION }}" '(.packages[0].version) = $v' server.json) > server.json
- name: Install Dependencies
run: bun install
- name: Build
run: bun run build
- name: Set NPM_TOKEN
run: npm config set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}}
- name: Publish
if: "!github.event.release.prerelease"
run: |
npm pkg delete scripts.prepare
npm publish --access public
- name: Publish release candidate
if: "github.event.release.prerelease"
run: |
npm pkg delete scripts.prepare
npm publish --access public --tag=canary
- name: Validate server.json
if: "!github.event.release.prerelease"
run: npx mcp-registry-validator validate server.json
- name: Install MCP Publisher
if: "!github.event.release.prerelease"
run: |
curl -L "https://github.com/modelcontextprotocol/registry/releases/download/v1.3.3/mcp-publisher_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz mcp-publisher
- name: Login to MCP Registry
if: "!github.event.release.prerelease"
run: ./mcp-publisher login github-oidc
- name: Publish to MCP Registry
if: "!github.event.release.prerelease"
run: ./mcp-publisher publish
```
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.yml:
--------------------------------------------------------------------------------
```yaml
name: Bug Report
description: Report a bug or issue with Context7 MCP
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this issue! Please fill out the form below to help us investigate.
- type: dropdown
id: client
attributes:
label: MCP Client
description: Which MCP client are you using?
options:
- Cursor
- Claude Desktop
- Claude Code
- Windsurf
- VS Code
- Cline
- Zed
- Other (specify in description)
validations:
required: true
- type: input
id: version
attributes:
label: Context7 MCP Version
description: Which version of Context7 MCP are you using? (Check package.json or npm list)
placeholder: e.g., 1.0.21
validations:
required: true
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear description of what the bug is
placeholder: When I try to...
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Install Context7 MCP via...
2. Run the command...
3. See error...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What you expected to happen
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened
validations:
required: true
- type: textarea
id: logs
attributes:
label: Error Messages / Logs
description: Please copy and paste any relevant error messages or logs
render: shell
- type: dropdown
id: transport
attributes:
label: Transport Method
description: Which transport method are you using?
options:
- stdio (default)
- http
- SSE (deprecated)
validations:
required: true
- type: input
id: node-version
attributes:
label: Node.js Version
description: Output of `node --version`
placeholder: e.g., v20.10.0
- type: input
id: os
attributes:
label: Operating System
description: Which OS are you running?
placeholder: e.g., macOS 14.2, Windows 11, Ubuntu 22.04
- type: textarea
id: config
attributes:
label: Configuration
description: Your Context7 MCP configuration (remove any API keys!)
render: json
placeholder: |
{
"mcpServers": {
"context7": {
"command": "npx",
"args": ["-y", "@upstash/context7-mcp"]
}
}
}
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context about the problem (proxy settings, firewalls, etc.)
```
--------------------------------------------------------------------------------
/public/context7-logo.svg:
--------------------------------------------------------------------------------
```
<svg width="130" height="28" viewBox="0 0 130 28" fill="none" xmlns="http://www.w3.org/2000/svg">
<rect width="28" height="28" rx="4" fill="black" style="fill:black;fill-opacity:1;"/>
<path d="M10.5724 15.2565C10.5724 17.5025 9.6613 19.3778 8.17805 21.1047H11.6319L11.6319 22.7786H6.33459V21.1895C7.95557 19.3566 8.58065 17.8628 8.58065 15.2565L10.5724 15.2565Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M17.4276 15.2565C17.4276 17.5025 18.3387 19.3778 19.822 21.1047H16.3681V22.7786H21.6654V21.1895C20.0444 19.3566 19.4194 17.8628 19.4194 15.2565H17.4276Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M10.5724 12.7435C10.5724 10.4975 9.66131 8.62224 8.17807 6.89532L11.6319 6.89532V5.22137L6.33461 5.22137V6.81056C7.95558 8.64343 8.58066 10.1373 8.58066 12.7435L10.5724 12.7435Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M17.4276 12.7435C17.4276 10.4975 18.3387 8.62224 19.822 6.89532L16.3681 6.89532L16.3681 5.22138L21.6654 5.22138V6.81056C20.0444 8.64343 19.4194 10.1373 19.4194 12.7435H17.4276Z" fill="white" style="fill:white;fill-opacity:1;"/>
<path d="M42.1 21.32C38.6 21.32 36.6 18.5 36.6 13.92C36.6 9.32 38.6 6.48 42.1 6.48C44.94 6.48 46.82 8.44 47.28 11.94L44.02 12.08C43.78 10.28 43.08 9.28 42.1 9.28C40.7 9.28 39.9 10.94 39.9 13.92C39.9 16.88 40.7 18.52 42.1 18.52C43.06 18.52 43.82 17.48 44.06 15.56L47.32 15.7C46.86 19.28 44.98 21.32 42.1 21.32ZM53.5922 21.24C50.5122 21.24 48.4322 19.04 48.4322 15.62C48.4322 12.2 50.5122 10 53.5922 10C56.6722 10 58.7522 12.2 58.7522 15.62C58.7522 19.04 56.6722 21.24 53.5922 21.24ZM53.5922 18.58C54.8722 18.58 55.5922 17.56 55.5922 15.62C55.5922 13.68 54.8722 12.66 53.5922 12.66C52.3122 12.66 51.5922 13.68 51.5922 15.62C51.5922 17.56 52.3122 18.58 53.5922 18.58ZM60.5444 21V10.24H63.3244L63.3844 12.16C63.9444 10.68 65.0844 10 66.5844 10C68.8444 10 69.8244 11.62 69.8244 14.02V21H66.7644V14.68C66.7644 13.2 66.3044 12.56 65.3444 12.56C64.4244 12.56 63.6044 13.32 63.6044 14.84V21H60.5444ZM78.2166 21C75.6766 21 74.5566 19.88 74.5566 17.5V12.62H71.6166V10.24H74.5566V7.72H77.6166V10.24H81.4966V12.62H77.6166V17.16C77.6166 18.14 78.0766 18.62 79.0766 18.62H81.4966V21H78.2166ZM88.4088 21.24C85.3888 21.24 83.2488 19.04 83.2488 15.62C83.2488 12.3 85.3488 10 88.3888 10C91.4088 10 93.5288 12.28 93.5288 15.68V16.42H86.3688C86.5088 17.8 87.3088 18.58 88.4888 18.58C89.3488 18.58 90.0088 18.14 90.2688 17.42L93.2888 17.64C92.5088 20 90.8688 21.24 88.4088 21.24ZM86.4288 14.46H90.2488C90.1288 13.28 89.4288 12.66 88.3488 12.66C87.2688 12.66 86.5688 13.3 86.4288 14.46ZM94.5009 21L98.2809 15.5L94.6609 10.24H97.9409L99.9609 13.4L101.961 10.24H105.241L101.681 15.5L105.421 21H102.161L99.9609 17.56L97.7809 21H94.5009ZM112.993 21C110.453 21 109.333 19.88 109.333 17.5V12.62H106.393V10.24H109.333V7.72H112.393V10.24H116.273V12.62H112.393V17.16C112.393 18.14 112.853 18.62 113.853 18.62H116.273V21H112.993ZM120.305 21C120.305 16.72 122.065 13 124.945 9.66H118.185V6.8H128.105V9.52C124.945 13.1 123.685 16.1 123.685 21H120.305Z" fill="black" style="fill:black;fill-opacity:1;"/>
</svg>
```
--------------------------------------------------------------------------------
/schema/context7.json:
--------------------------------------------------------------------------------
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://context7.com/schema/context7.json",
"title": "Context7 Configuration Schema",
"description": "Configuration file for Context7 project parsing and documentation generation",
"type": "object",
"properties": {
"projectTitle": {
"type": "string",
"description": "The display name for your project in Context7. This overrides the default repository name.",
"minLength": 1,
"maxLength": 100,
"examples": ["Upstash Ratelimit", "Next.js", "React Query"]
},
"description": {
"type": "string",
"description": "A brief description of what your library does. This helps coding agents understand the purpose of your project.",
"minLength": 10,
"maxLength": 200,
"examples": [
"Ratelimiting library based on Upstash Redis",
"The React Framework for Production",
"Powerful data synchronization for React"
]
},
"folders": {
"type": "array",
"description": "Specific folder paths to include when parsing documentation. If empty, Context7 will scan the entire repository. Supports regex patterns and requires full paths.",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true,
"default": [],
"examples": [
["docs", "guides", "examples"],
["documentation/**"],
["api-reference", "tutorials/*"]
]
},
"excludeFolders": {
"type": "array",
"description": "Folder paths to exclude from documentation parsing. Supports regex patterns and requires full paths.",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true,
"default": [],
"examples": [
["src", "build", "node_modules"],
["**/test/**", "**/tests/**"],
["legacy/*", "archive"]
]
},
"excludeFiles": {
"type": "array",
"description": "Specific file names to exclude from documentation parsing. Only include the filename (not the path). Regex patterns are not supported.",
"items": {
"type": "string",
"minLength": 1,
"pattern": "^[^/\\\\]+$"
},
"uniqueItems": true,
"default": [],
"examples": [
["CHANGELOG.md", "LICENSE"],
["README-dev.md", "CONTRIBUTING.md"],
["package.json", "tsconfig.json"]
]
},
"rules": {
"type": "array",
"description": "Best practices or important guidelines that coding agents should follow when using your library. These appear as recommendations in the documentation context.",
"items": {
"type": "string",
"minLength": 5,
"maxLength": 200
},
"default": [],
"examples": [
["Always use TypeScript for better type safety"],
["Use Upstash Redis as a database", "Use single region set up"],
["Import components from the main package", "Follow the naming conventions"]
]
},
"previousVersions": {
"type": "array",
"description": "Information about previous versions of your library that should also be available in Context7.",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "The Git tag or version identifier",
"pattern": "^v?\\d+\\.\\d+\\.\\d+",
"examples": ["v1.2.1", "2.0.0", "v3.1.0-beta.1"]
},
"title": {
"type": "string",
"description": "Human-readable version name",
"minLength": 1,
"maxLength": 50,
"examples": ["version 1.2.1", "Legacy Version", "Beta Release"]
}
},
"required": ["tag", "title"],
"additionalProperties": false
},
"default": []
}
},
"additionalProperties": false,
"examples": [
{
"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"
}
]
}
]
}
```
--------------------------------------------------------------------------------
/src/lib/api.ts:
--------------------------------------------------------------------------------
```typescript
import { SearchResponse } from "./types.js";
import { generateHeaders } from "./encryption.js";
import { ProxyAgent, setGlobalDispatcher } from "undici";
const CONTEXT7_API_BASE_URL = "https://context7.com/api";
const DEFAULT_TYPE = "txt";
// Pick up proxy configuration in a variety of common env var names.
const PROXY_URL: string | null =
process.env.HTTPS_PROXY ??
process.env.https_proxy ??
process.env.HTTP_PROXY ??
process.env.http_proxy ??
null;
if (PROXY_URL && !PROXY_URL.startsWith("$") && /^(http|https):\/\//i.test(PROXY_URL)) {
try {
// Configure a global proxy agent once at startup. Subsequent fetch calls will
// automatically use this dispatcher.
// Using `any` cast because ProxyAgent implements the Dispatcher interface but
// TS may not infer it correctly in some versions.
setGlobalDispatcher(new ProxyAgent(PROXY_URL));
} catch (error) {
// Don't crash the app if proxy initialisation fails – just log a warning.
console.error(
`[Context7] Failed to configure proxy agent for provided proxy URL: ${PROXY_URL}:`,
error
);
}
}
/**
* Searches for libraries matching the given query
* @param query The search query
* @param clientIp Optional client IP address to include in headers
* @param apiKey Optional API key for authentication
* @returns Search results or null if the request fails
*/
export async function searchLibraries(
query: string,
clientIp?: string,
apiKey?: string
): Promise<SearchResponse> {
try {
const url = new URL(`${CONTEXT7_API_BASE_URL}/v1/search`);
url.searchParams.set("query", query);
const headers = generateHeaders(clientIp, apiKey);
const response = await fetch(url, { headers });
if (!response.ok) {
const errorCode = response.status;
if (errorCode === 429) {
const errorMessage = apiKey
? "Rate limited due to too many requests. Please try again later."
: "Rate limited due to too many requests. You can create a free API key at https://context7.com/dashboard for higher rate limits.";
console.error(errorMessage);
return {
results: [],
error: errorMessage,
} as SearchResponse;
}
if (errorCode === 401) {
const errorMessage =
"Unauthorized. Please check your API key. The API key you provided (possibly incorrect) is: " +
apiKey +
". API keys should start with 'ctx7sk'";
console.error(errorMessage);
return {
results: [],
error: errorMessage,
} as SearchResponse;
}
const errorMessage = `Failed to search libraries. Please try again later. Error code: ${errorCode}`;
console.error(errorMessage);
return {
results: [],
error: errorMessage,
} as SearchResponse;
}
return await response.json();
} catch (error) {
const errorMessage = `Error searching libraries: ${error}`;
console.error(errorMessage);
return { results: [], error: errorMessage } as SearchResponse;
}
}
/**
* Fetches documentation context for a specific library
* @param libraryId The library ID to fetch documentation for
* @param options Options for the request
* @param clientIp Optional client IP address to include in headers
* @param apiKey Optional API key for authentication
* @returns The documentation text or null if the request fails
*/
export async function fetchLibraryDocumentation(
libraryId: string,
options: {
tokens?: number;
topic?: string;
} = {},
clientIp?: string,
apiKey?: string
): Promise<string | null> {
try {
if (libraryId.startsWith("/")) {
libraryId = libraryId.slice(1);
}
const url = new URL(`${CONTEXT7_API_BASE_URL}/v1/${libraryId}`);
if (options.tokens) url.searchParams.set("tokens", options.tokens.toString());
if (options.topic) url.searchParams.set("topic", options.topic);
url.searchParams.set("type", DEFAULT_TYPE);
const headers = generateHeaders(clientIp, apiKey, { "X-Context7-Source": "mcp-server" });
const response = await fetch(url, { headers });
if (!response.ok) {
const errorCode = response.status;
if (errorCode === 429) {
const errorMessage = apiKey
? "Rate limited due to too many requests. Please try again later."
: "Rate limited due to too many requests. You can create a free API key at https://context7.com/dashboard for higher rate limits.";
console.error(errorMessage);
return errorMessage;
}
if (errorCode === 404) {
const errorMessage =
"The library you are trying to access does not exist. Please try with a different library ID.";
console.error(errorMessage);
return errorMessage;
}
if (errorCode === 401) {
const errorMessage =
"Unauthorized. Please check your API key. The API key you provided (possibly incorrect) is: " +
apiKey +
". API keys should start with 'ctx7sk'";
console.error(errorMessage);
return errorMessage;
}
const errorMessage = `Failed to fetch documentation. Please try again later. Error code: ${errorCode}`;
console.error(errorMessage);
return errorMessage;
}
const text = await response.text();
if (!text || text === "No content available" || text === "No context data available") {
return null;
}
return text;
} catch (error) {
const errorMessage = `Error fetching library documentation. Please try again later. ${error}`;
console.error(errorMessage);
return errorMessage;
}
}
```
--------------------------------------------------------------------------------
/docs/adding-projects.md:
--------------------------------------------------------------------------------
```markdown
# 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"
}
]
}
```
> **💡 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
- **`branchVersions`** (array): Information about previous versions (branch based) of your library that should also
be available in Context7.
- **`branch`**: The Git branch
### 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.
```
--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
```typescript
#!/usr/bin/env node
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import { searchLibraries, fetchLibraryDocumentation } from "./lib/api.js";
import { formatSearchResults } from "./lib/utils.js";
import { SearchResponse } from "./lib/types.js";
import express from "express";
import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
import { Command } from "commander";
import { AsyncLocalStorage } from "async_hooks";
/** Minimum allowed tokens for documentation retrieval */
const MINIMUM_TOKENS = 1000;
/** Default tokens when none specified */
const DEFAULT_TOKENS = 5000;
/** Default HTTP server port */
const DEFAULT_PORT = 3000;
// Parse CLI arguments using commander
const program = new Command()
.option("--transport <stdio|http>", "transport type", "stdio")
.option("--port <number>", "port for HTTP transport", DEFAULT_PORT.toString())
.option("--api-key <key>", "API key for authentication (or set CONTEXT7_API_KEY env var)")
.allowUnknownOption() // let MCP Inspector / other wrappers pass through extra flags
.parse(process.argv);
const cliOptions = program.opts<{
transport: string;
port: string;
apiKey?: string;
}>();
// Validate transport option
const allowedTransports = ["stdio", "http"];
if (!allowedTransports.includes(cliOptions.transport)) {
console.error(
`Invalid --transport value: '${cliOptions.transport}'. Must be one of: stdio, http.`
);
process.exit(1);
}
// Transport configuration
const TRANSPORT_TYPE = (cliOptions.transport || "stdio") as "stdio" | "http";
// Disallow incompatible flags based on transport
const passedPortFlag = process.argv.includes("--port");
const passedApiKeyFlag = process.argv.includes("--api-key");
if (TRANSPORT_TYPE === "http" && passedApiKeyFlag) {
console.error(
"The --api-key flag is not allowed when using --transport http. Use header-based auth at the HTTP layer instead."
);
process.exit(1);
}
if (TRANSPORT_TYPE === "stdio" && passedPortFlag) {
console.error("The --port flag is not allowed when using --transport stdio.");
process.exit(1);
}
// HTTP port configuration
const CLI_PORT = (() => {
const parsed = parseInt(cliOptions.port, 10);
return isNaN(parsed) ? undefined : parsed;
})();
const requestContext = new AsyncLocalStorage<{
clientIp?: string;
apiKey?: string;
}>();
function getClientIp(req: express.Request): string | undefined {
const forwardedFor = req.headers["x-forwarded-for"] || req.headers["X-Forwarded-For"];
if (forwardedFor) {
const ips = Array.isArray(forwardedFor) ? forwardedFor[0] : forwardedFor;
const ipList = ips.split(",").map((ip) => ip.trim());
for (const ip of ipList) {
const plainIp = ip.replace(/^::ffff:/, "");
if (
!plainIp.startsWith("10.") &&
!plainIp.startsWith("192.168.") &&
!/^172\.(1[6-9]|2[0-9]|3[0-1])\./.test(plainIp)
) {
return plainIp;
}
}
return ipList[0].replace(/^::ffff:/, "");
}
if (req.socket?.remoteAddress) {
return req.socket.remoteAddress.replace(/^::ffff:/, "");
}
return undefined;
}
const server = new McpServer(
{
name: "Context7",
version: "1.0.13",
},
{
instructions:
"Use this server to retrieve up-to-date documentation and code examples for any library.",
}
);
server.registerTool(
"resolve-library-id",
{
title: "Resolve Context7 Library ID",
description: `Resolves a package/product name to a Context7-compatible library ID and returns a list of matching libraries.
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.
Selection Process:
1. Analyze the query to understand what library/package the user is looking for
2. Return the most relevant match based on:
- Name similarity to the query (exact matches prioritized)
- Description relevance to the query's intent
- Documentation coverage (prioritize libraries with higher Code Snippet counts)
- Trust score (consider libraries with scores of 7-10 more authoritative)
Response Format:
- Return the selected library ID in a clearly marked section
- Provide a brief explanation for why this library was chosen
- If multiple good matches exist, acknowledge this but proceed with the most relevant one
- If no good matches exist, clearly state this and suggest query refinements
For ambiguous queries, request clarification before proceeding with a best-guess match.`,
inputSchema: {
libraryName: z
.string()
.describe("Library name to search for and retrieve a Context7-compatible library ID."),
},
},
async ({ libraryName }) => {
const ctx = requestContext.getStore();
const searchResponse: SearchResponse = await searchLibraries(
libraryName,
ctx?.clientIp,
ctx?.apiKey
);
if (!searchResponse.results || searchResponse.results.length === 0) {
return {
content: [
{
type: "text",
text: searchResponse.error
? searchResponse.error
: "Failed to retrieve library documentation data from Context7",
},
],
};
}
const resultsText = formatSearchResults(searchResponse);
const responseText = `Available Libraries (top matches):
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
- Versions: List of versions if available. Use one of those versions if the user provides a version in their query. The format of the version is /org/project/version.
For best results, select libraries based on name match, trust score, snippet coverage, and relevance to your use case.
----------
${resultsText}`;
return {
content: [
{
type: "text",
text: responseText,
},
],
};
}
);
server.registerTool(
"get-library-docs",
{
title: "Get Library Docs",
description:
"Fetches up-to-date documentation for a library. You must call 'resolve-library-id' first to obtain the exact Context7-compatible library ID required to use this tool, UNLESS the user explicitly provides a library ID in the format '/org/project' or '/org/project/version' in their query.",
inputSchema: {
context7CompatibleLibraryID: z
.string()
.describe(
"Exact Context7-compatible library ID (e.g., '/mongodb/docs', '/vercel/next.js', '/supabase/supabase', '/vercel/next.js/v14.3.0-canary.87') retrieved from 'resolve-library-id' or directly from user query in the format '/org/project' or '/org/project/version'."
),
topic: z
.string()
.optional()
.describe("Topic to focus documentation on (e.g., 'hooks', 'routing')."),
tokens: z
.preprocess((val) => (typeof val === "string" ? Number(val) : val), z.number())
.transform((val) => (val < MINIMUM_TOKENS ? MINIMUM_TOKENS : val))
.optional()
.describe(
`Maximum number of tokens of documentation to retrieve (default: ${DEFAULT_TOKENS}). Higher values provide more context but consume more tokens.`
),
},
},
async ({ context7CompatibleLibraryID, tokens = DEFAULT_TOKENS, topic = "" }) => {
const ctx = requestContext.getStore();
const fetchDocsResponse = await fetchLibraryDocumentation(
context7CompatibleLibraryID,
{
tokens,
topic,
},
ctx?.clientIp,
ctx?.apiKey
);
if (!fetchDocsResponse) {
return {
content: [
{
type: "text",
text: "Documentation not found or not finalized for this library. This might have happened because you used an invalid Context7-compatible library ID. To get a valid Context7-compatible library ID, use the 'resolve-library-id' with the package name you wish to retrieve documentation for.",
},
],
};
}
return {
content: [
{
type: "text",
text: fetchDocsResponse,
},
],
};
}
);
async function main() {
const transportType = TRANSPORT_TYPE;
if (transportType === "http") {
const initialPort = CLI_PORT ?? DEFAULT_PORT;
let actualPort = initialPort;
const app = express();
app.use(express.json());
app.use((req: express.Request, res: express.Response, next: express.NextFunction) => {
res.setHeader("Access-Control-Allow-Origin", "*");
res.setHeader("Access-Control-Allow-Methods", "GET,POST,OPTIONS,DELETE");
res.setHeader(
"Access-Control-Allow-Headers",
"Content-Type, MCP-Session-Id, MCP-Protocol-Version, X-Context7-API-Key, Context7-API-Key, X-API-Key, Authorization"
);
res.setHeader("Access-Control-Expose-Headers", "MCP-Session-Id");
if (req.method === "OPTIONS") {
res.sendStatus(200);
return;
}
next();
});
const extractHeaderValue = (value: string | string[] | undefined): string | undefined => {
if (!value) return undefined;
return typeof value === "string" ? value : value[0];
};
const extractBearerToken = (authHeader: string | string[] | undefined): string | undefined => {
const header = extractHeaderValue(authHeader);
if (!header) return undefined;
if (header.startsWith("Bearer ")) {
return header.substring(7).trim();
}
return header;
};
const extractApiKey = (req: express.Request): string | undefined => {
return (
extractBearerToken(req.headers.authorization) ||
extractHeaderValue(req.headers["Context7-API-Key"]) ||
extractHeaderValue(req.headers["X-API-Key"]) ||
extractHeaderValue(req.headers["context7-api-key"]) ||
extractHeaderValue(req.headers["x-api-key"]) ||
extractHeaderValue(req.headers["Context7_API_Key"]) ||
extractHeaderValue(req.headers["X_API_Key"]) ||
extractHeaderValue(req.headers["context7_api_key"]) ||
extractHeaderValue(req.headers["x_api_key"])
);
};
app.all("/mcp", async (req: express.Request, res: express.Response) => {
try {
const clientIp = getClientIp(req);
const apiKey = extractApiKey(req);
const transport = new StreamableHTTPServerTransport({
sessionIdGenerator: undefined,
enableJsonResponse: true,
});
res.on("close", () => {
transport.close();
});
await requestContext.run({ clientIp, apiKey }, async () => {
await server.connect(transport);
await transport.handleRequest(req, res, req.body);
});
} catch (error) {
console.error("Error handling MCP request:", error);
if (!res.headersSent) {
res.status(500).json({
jsonrpc: "2.0",
error: { code: -32603, message: "Internal server error" },
id: null,
});
}
}
});
app.get("/ping", (_req: express.Request, res: express.Response) => {
res.json({ status: "ok", message: "pong" });
});
// Catch-all 404 handler - must be after all other routes
app.use((_req: express.Request, res: express.Response) => {
res.status(404).json({
error: "not_found",
message: "Endpoint not found. Use /mcp for MCP protocol communication.",
});
});
const startServer = (port: number, maxAttempts = 10) => {
const httpServer = app.listen(port, () => {
actualPort = port;
console.error(
`Context7 Documentation MCP Server running on HTTP at http://localhost:${actualPort}/mcp`
);
});
httpServer.on("error", (err: NodeJS.ErrnoException) => {
if (err.code === "EADDRINUSE" && port < initialPort + maxAttempts) {
console.warn(`Port ${port} is in use, trying port ${port + 1}...`);
startServer(port + 1, maxAttempts);
} else {
console.error(`Failed to start server: ${err.message}`);
process.exit(1);
}
});
};
startServer(initialPort);
} else {
const apiKey = cliOptions.apiKey || process.env.CONTEXT7_API_KEY;
const transport = new StdioServerTransport();
await requestContext.run({ apiKey }, async () => {
await server.connect(transport);
});
console.error("Context7 Documentation MCP Server running on stdio");
}
}
main().catch((error) => {
console.error("Fatal error in main():", error);
process.exit(1);
});
```