@upstash/context7-mcp 1.0.6 → 1.0.8

package/README.md

@@ -1,8 +1,9 @@
-# Context7 MCP - Up-to-date Docs For Any Prompt
+# Context7 MCP - Up-to-date Code Docs For Any Prompt
 
-[![Website](https://img.shields.io/badge/Website-context7.com-blue)](https://context7.com) [![smithery badge](https://smithery.ai/badge/@upstash/context7-mcp)](https://smithery.ai/server/@upstash/context7-mcp) [<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%257B%2522name%2522%253A%2522context7%2522%252C%2522config%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540upstash%252Fcontext7-mcp%2540latest%2522%255D%257D%257D)
+[![Website](https://img.shields.io/badge/Website-context7.com-blue)](https://context7.com) [![smithery badge](https://smithery.ai/badge/@upstash/context7-mcp)](https://smithery.ai/server/@upstash/context7-mcp) [<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)
+
+[![中文文档](https://img.shields.io/badge/docs-中文版-yellow)](./docs/README.zh-CN.md) [![한국어 문서](https://img.shields.io/badge/docs-한국어-green)](./docs/README.ko.md) [![Documentación en Español](https://img.shields.io/badge/docs-Español-orange)](./docs/README.es.md) [![Documentation en Français](https://img.shields.io/badge/docs-Français-blue)](./docs/README.fr.md) [![Documentação em Português (Brasil)](https://img.shields.io/badge/docs-Português%20(Brasil)-purple)](./docs/README.pt-BR.md) [![Documentazione in italiano](https://img.shields.io/badge/docs-Italian-red)](./docs/README.it.md) [![Dokumentasi Bahasa Indonesia](https://img.shields.io/badge/docs-Bahasa%20Indonesia-pink)](./docs/README.id-ID.md) [![Dokumentation auf Deutsch](https://img.shields.io/badge/docs-Deutsch-darkgreen)](./docs/README.de.md) [![Документация на русском языке](https://img.shields.io/badge/docs-Русский-darkblue)](./docs/README.ru.md) [![Türkçe Doküman](https://img.shields.io/badge/docs-Türkçe-blue)](./docs/README.tr.md)
 
-[![中文文档](https://img.shields.io/badge/docs-中文版-yellow)](./docs/README.zh-CN.md) [![한국어 문서](https://img.shields.io/badge/docs-한국어-green)](./docs/README.ko.md)
 
 ## ❌ Without Context7
 
@@ -53,7 +54,7 @@ npx -y @smithery/cli install @upstash/context7-mcp --client claude
 
 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. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.
+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
 {
@@ -90,7 +91,7 @@ Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file i
   "mcpServers": {
     "context7": {
       "command": "deno",
-      "args": ["run", "--allow-net", "npm:@upstash/context7-mcp"]
+      "args": ["run", "--allow-env", "--allow-net", "npm:@upstash/context7-mcp"]
     }
   }
 }
@@ -115,8 +116,8 @@ Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.
 
 ### Install in VS Code
 
-[<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%257B%2522name%2522%253A%2522context7%2522%252C%2522config%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540upstash%252Fcontext7-mcp%2540latest%2522%255D%257D%257D)
-[<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%257B%2522name%2522%253A%2522context7%2522%252C%2522config%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540upstash%252Fcontext7-mcp%2540latest%2522%255D%257D%257D)
+[<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.
 
@@ -132,6 +133,24 @@ Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.vi
 }
 ```
 
+### Install in Zed
+
+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": {
+      "command": {
+        "path": "npx",
+        "args": ["-y", "@upstash/context7-mcp@latest"]
+      },
+      "settings": {}
+    }
+  }
+}
+```
+
 ### Install in Claude Code
 
 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.
@@ -155,6 +174,120 @@ Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude D
 }
 ```
 
+### Install in BoltAI
+
+Open the "Settings" page of the app, navigate to "Plugins," and enter the following JSON:
+
+```json
+{
+	"mcpServers": {
+		"context7": {
+			"args": ["-y", "@upstash/context7-mcp@latest"],
+			"command": "npx"
+		}
+	}
+}
+```
+
+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).
+
+### Using Docker
+
+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@latest
+
+    # 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.*
+
+### Install in Windows
+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@latest"
+      ],
+      "disabled": false,
+      "autoApprove": []
+    }
+  }
+}
+```
+
+### Environment Variables
+
+- `DEFAULT_MINIMUM_TOKENS`: Set the minimum token count for documentation retrieval (default: 10000).
+
+Examples:
+
+```json
+{
+  "mcpServers": {
+    "context7": {
+      "command": "npx",
+      "args": ["-y", "@upstash/context7-mcp@latest"],
+      "env": {
+        "DEFAULT_MINIMUM_TOKENS": "10000"
+      }
+    }
+  }
+}
+```
+
 ### Available Tools
 
 - `resolve-library-id`: Resolves a general library name into a Context7-compatible library ID.
@@ -162,7 +295,7 @@ Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude D
 - `get-library-docs`: Fetches documentation for a library using a Context7-compatible library ID.
   - `context7CompatibleLibraryID` (required)
   - `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 5000 are automatically increased to 5000.
+  - `tokens` (optional, default 10000): Max number of tokens to return. Values less than the configured `DEFAULT_MINIMUM_TOKENS` value or the default value of 10000 are automatically increased to that value.
 
 ## Development
 
@@ -216,6 +349,25 @@ If you see this error, try using `bunx` instead of `npx`.
 
 This often resolves module resolution issues, especially in environments where `npx` does not properly install or resolve packages.
 
+### ESM Resolution Issues
+
+If you encounter an error like: `Error: Cannot find module 'uriTemplate.js'` try running with the `--experimental-vm-modules` flag:
+
+```json
+{
+  "mcpServers": {
+    "context7": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "--node-options=--experimental-vm-modules",
+        "@upstash/context7-mcp@1.0.6"
+      ]
+    }
+  }
+}
+```
+
 ### MCP Client Errors
 
 1. Try removing `@latest` from the package name.
@@ -224,6 +376,12 @@ This often resolves module resolution issues, especially in environments where `
 
 3. Try using `deno` as an alternative.
 
+4. Make sure you are using Node v18 or higher to have native fetch support with `npx`.
+
+## Disclaimer
+
+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.
+
 ## Context7 In Media
 
 - [Better Stack: "Free Tool Makes Cursor 10x Smarter"](https://youtu.be/52FC3qObp9E)
@@ -232,6 +390,8 @@ This often resolves module resolution issues, especially in environments where `
 - [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
 

package/dist/index.js

@@ -4,19 +4,42 @@ 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";
-const DEFAULT_MINIMUM_TOKENS = 5000;
+import dotenv from "dotenv";
+// Load environment variables from .env file if present
+dotenv.config();
+// Get DEFAULT_MINIMUM_TOKENS from environment variable or use default
+let DEFAULT_MINIMUM_TOKENS = 10000;
+if (process.env.DEFAULT_MINIMUM_TOKENS) {
+    const parsedValue = parseInt(process.env.DEFAULT_MINIMUM_TOKENS, 10);
+    if (!isNaN(parsedValue) && parsedValue > 0) {
+        DEFAULT_MINIMUM_TOKENS = parsedValue;
+    }
+    else {
+        console.warn(`Warning: Invalid DEFAULT_MINIMUM_TOKENS value provided in environment variable. Using default value of 10000`);
+    }
+}
 // Create server instance
 const server = new McpServer({
     name: "Context7",
     description: "Retrieves up-to-date documentation and code examples for any library.",
-    version: "1.0.6",
+    version: "v1.0.8",
     capabilities: {
         resources: {},
         tools: {},
     },
 });
 // Register Context7 tools
-server.tool("resolve-library-id", "Required first step: Resolves a general package name into a Context7-compatible library ID. Must be called before using 'get-library-docs' to retrieve a valid Context7-compatible library ID.", {
+server.tool("resolve-library-id", `Resolves a package 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.
+
+When selecting the best match, consider:
+- Name similarity to the query
+- Description relevance
+- Code Snippet count (documentation coverage)
+- GitHub Stars (popularity)
+
+Return the selected library ID and explain your choice. If there are multiple good matches, mention this but proceed with the most relevant one.`, {
     libraryName: z
         .string()
         .describe("Library name to search for and retrieve a Context7-compatible library ID."),
@@ -47,7 +70,20 @@ server.tool("resolve-library-id", "Required first step: Resolves a general packa
         content: [
             {
                 type: "text",
-                text: "Available libraries and their Context7-compatible library IDs:\n\n" + resultsText,
+                text: `Available Libraries (top matches):
+
+Each result includes:
+- Library ID: Context7-compatible identifier (format: /org/repo)
+- Name: Library or package name
+- Description: Short summary
+- Code Snippets: Number of available code examples
+- GitHub Stars: Popularity indicator
+
+For best results, select libraries based on name match, popularity (stars), snippet coverage, and relevance to your use case.
+
+---
+
+${resultsText}`,
             },
         ],
     };

package/dist/lib/utils.js

@@ -1,20 +1,39 @@
 /**
- * Format a search result into a string representation
- * @param result SearchResult to format
- * @returns Formatted search result string
+ * 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) {
-    return `Title: ${result.title}\n\nContext7-compatible library ID: ${result.id}\n\nDescription: ${result.description}`;
+    // 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 GitHub stars if it's a valid value
+    if (result.stars !== -1 && result.stars !== undefined) {
+        formattedResult.push(`- GitHub Stars: ${result.stars}`);
+    }
+    // Join all parts with newlines
+    return formattedResult.join("\n");
 }
 /**
- * Format search results into a string representation
- * @param searchResponse The search response to format
- * @returns Formatted search results string
+ * 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) {
     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--------------------\n");
+    return formattedResults.join("\n---\n");
 }

package/package.json

@@ -1 +1 @@
-{"name":"@upstash/context7-mcp","version":"v1.0.6","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"},"repository":{"type":"git","url":"git+https://github.com/upstash/context7.git"},"keywords":["modelcontextprotocol","mcp","context7"],"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.8.0","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.23.0","eslint-config-prettier":"^10.1.1","eslint-plugin-prettier":"^5.2.5","prettier":"^3.5.3","typescript":"^5.8.2","typescript-eslint":"^8.28.0"}}
+{"name":"@upstash/context7-mcp","version":"v1.0.8","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"},"repository":{"type":"git","url":"git+https://github.com/upstash/context7.git"},"keywords":["modelcontextprotocol","mcp","context7"],"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.8.0","dotenv":"^16.5.0","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.23.0","eslint-config-prettier":"^10.1.1","eslint-plugin-prettier":"^5.2.5","prettier":"^3.5.3","typescript":"^5.8.2","typescript-eslint":"^8.28.0"}}