@upstash/context7-mcp 1.0.0 → 1.0.1-rc

package/README.md

@@ -1,34 +1,66 @@
-# Context7 MCP Server
+# Context7 MCP - Up-to-date Docs For Any Cursor Prompt
 
-In this repository, we provide an MCP Server for [Context7](https://context7.com), which offers access to high-quality documentation for popular libraries.
+## ❌ Without Context7
 
-This lets you use Cursor, Windsurf, Claude Desktop, or any MCP Client, to use natural language to search and access documentation for libraries, e.g.:
+LLMs rely on outdated or generic information about the libraries you use. You get:
 
-- "What are the main features of React hooks?"
-- "How do I implement authentication with Next.js?"
-- "Rate limiting with Redis"
-- "Get examples of using React Query"
+- ❌ Code examples are outdated and based on year-old training data
+- ❌ Hallucinated APIs don't even exist
+- ❌ Generic answers for old package versions
 
-## Usage
+## ✅ 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 question in Cursor:
+
+```
+"How do I use the new Next.js `after` function? use context7"
+```
+
+```
+"How do I invalidate a query in React Query? use context7"
+```
+
+```
+"How do I protect a route with NextAuth? use context7"
+```
+
+Context7 fetches up-to-date documentation and working code examples right into your LLM’s context.
+
+- 1️⃣ Ask your question 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 generations.
+
+## 🛠️ Getting Started
 
 ### Requirements
 
 - Node.js >= v18.0.0
 - Cursor, Windsurf, Claude Desktop or another MCP Client
 
-### How to use locally
+### Install in Cursor
 
-#### Installing for Cursor
+Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`
 
-Add this command to the MCP list in Cursor. For more info, check the [Cursor MCP](https://docs.cursor.com/context/model-context-protocol) docs.
+Paste this into your Cursor `~/.cursor/mcp.json` file. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info. 
 
-```bash
-npx -y @upstash/context7-mcp
+```json
+{
+  "mcpServers": {
+    "context7": {
+      "command": "npx",
+      "args": ["-y", "@upstash/context7-mcp"]
+    }
+  }
+}
 ```
 
-#### Installing for Windsurf
+### Install in Windsurf
 
-Add this to your Windsurf MCP config file. For more info, check the [Windsurf MCP](https://docs.windsurf.com/windsurf/mcp) docs.
+Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/mcp) for more info.
 
 ```json
 {
@@ -41,43 +73,37 @@ Add this to your Windsurf MCP config file. For more info, check the [Windsurf MC
 }
 ```
 
-### Tools
+### Available Tools
 
-- `list-available-docs`: Lists all available documentation libraries from Context7
-- `get-library-documentation`: Retrieves documentation for a specific library with options for:
-  - `libraryName`: Name of the library to retrieve docs for
-  - `topic`: Specific topic within the library
-  - `tokens`: Maximum tokens to retrieve (default: 5000)
+- `resolve-library-id`: Resolves a general npm package name into a Context7-compatible library ID.
+  - `libraryName` (optional): Search and rerank results
+- `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
 
 ## Development
 
-Clone the project and run:
+Clone the project and install dependencies:
 
 ```bash
-npm install
+bun i
 ```
 
-You can use the following commands to format and lint the code:
+Build:
 
 ```bash
-npm run format
-npm run lint
+bun run build
 ```
 
-### Building
-
-```bash
-npm run build
-```
-
-### Local Configuration
+### Local Configuration Example
 
 ```json
 {
   "mcpServers": {
     "context7": {
-      "command": "node",
-      "args": ["/ABSOLUTE/PATH/TO/PARENT/FOLDER/context7-mcp/build/index.js"]
+      "command": "npx",
+      "args": ["tsx", "/path/to/folder/context7-mcp/src/index.ts"]
     }
   }
 }
@@ -85,8 +111,6 @@ npm run build
 
 ### Testing with MCP Inspector
 
-You can also use the MCP Inspector to test the tools by following the MCP documentation for setting up the inspector.
-
 ```bash
 npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp
 ```

package/{build → dist}/index.js

@@ -7,7 +7,7 @@ import { formatProjectsList, rerankProjects } from "./lib/utils.js";
 // Create server instance
 const server = new McpServer({
     name: "Context7",
-    description: "Retrieves documentation and code examples for software libraries.",
+    description: "Retrieves up-to-date documentation and code examples for npm packages.",
     version: "1.0.0",
     capabilities: {
         resources: {},
@@ -15,11 +15,11 @@ const server = new McpServer({
     },
 });
 // Register Context7 tools
-server.tool("list-available-docs", "Lists all available library documentation from Context7. The library names can be used with 'get-library-documentation' to retrieve documentation.", {
+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.", {
     libraryName: z
         .string()
         .optional()
-        .describe("Optional library name to search for and rerank results based on"),
+        .describe("Optional library name to search for and rerank results based on."),
 }, async ({ libraryName }) => {
     const projects = await fetchProjects();
     if (!projects) {
@@ -53,32 +53,32 @@ server.tool("list-available-docs", "Lists all available library documentation fr
         content: [
             {
                 type: "text",
-                text: projectsText,
+                text: "Available libraries and their Context7-compatible library ID:\n\n" + projectsText,
             },
         ],
     };
 });
-server.tool("get-library-documentation", "Retrieves documentation for a specific library from Context7. Use 'list-available-docs' first to see what's available.", {
-    libraryName: z
+server.tool("get-library-docs", "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.", {
+    context7CompatibleLibraryID: z
         .string()
-        .describe("Name of the library to retrieve documentation for (e.g., 'mongodb/docs', 'vercel/nextjs'). Must match exactly a library name from 'list-available-docs'."),
+        .describe("Exact Context7-compatible library ID (e.g., 'mongodb/docs', 'vercel/nextjs') retrieved from 'resolve-library-id'."),
     topic: z
         .string()
         .optional()
-        .describe("Specific topic within the library to focus the documentation on (e.g., 'hooks', 'routing')."),
+        .describe("Topic to focus documentation on (e.g., 'hooks', 'routing')."),
     tokens: z
         .number()
         .min(5000)
         .optional()
-        .describe("Maximum number of tokens of documentation to retrieve (default: 5000). Higher values provide more comprehensive documentation but use more context window."),
-}, async ({ libraryName, tokens = 5000, topic = "" }) => {
-    const documentationText = await fetchLibraryDocumentation(libraryName, tokens, topic);
+        .describe("Maximum number of tokens of documentation to retrieve (default: 5000). Higher values provide more context but consume more tokens."),
+}, async ({ context7CompatibleLibraryID, tokens = 5000, topic = "" }) => {
+    const documentationText = await fetchLibraryDocumentation(context7CompatibleLibraryID, tokens, topic);
     if (!documentationText) {
         return {
             content: [
                 {
                     type: "text",
-                    text: "Documentation not found or not finalized for this library. Verify you've provided a valid library name exactly as listed by the 'list-available-docs' tool.",
+                    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.",
                 },
             ],
         };

package/{build → dist}/lib/utils.js

@@ -4,7 +4,7 @@
  * @returns Formatted project string
  */
 export function formatProject(project) {
-    return `Title: ${project.settings.title}\nLibrary name: ${project.settings.project}\n`;
+    return `Title: ${project.settings.title}\nContext7-compatible library ID: ${project.settings.project}\n`;
 }
 /**
  * Format a list of projects into a string representation

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@upstash/context7-mcp",
-  "version": "1.0.0",
+  "version": "1.0.1-rc",
   "description": "MCP server for Context7",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc && chmod 755 build/index.js",
+    "build": "tsc && chmod 755 dist/index.js",
     "format": "prettier --write .",
     "lint": "eslint \"**/*.{js,ts,tsx}\" --fix"
   },
@@ -17,10 +17,10 @@
   "license": "MIT",
   "type": "module",
   "bin": {
-    "context7-mcp": "build/index.js"
+    "context7-mcp": "dist/index.js"
   },
   "files": [
-    "build"
+    "dist"
   ],
   "bugs": {
     "url": "https://github.com/upstash/context7-mcp/issues"