From 4fea661c906b331e523594a9280de72d41b3443d Mon Sep 17 00:00:00 2001 From: Abdusshh Date: Sun, 20 Apr 2025 11:18:46 +0300 Subject: [PATCH] chore: add badges and simplify runtime options in installation instructions --- README.md | 55 +++++++++++++++++++------------------------------------ 1 file changed, 19 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 5bc2352..74e4763 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Context7 MCP - Up-to-date Docs For Any Cursor 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) + ## ❌ Without Context7 LLMs rely on outdated or generic information about the libraries you use. You get: @@ -41,8 +43,6 @@ No tab-switching, no hallucinated APIs that don't exist, no outdated code genera - Node.js >= v18.0.0 - Cursor, Windsurf, Claude Desktop or another MCP Client -> **Note on Runtimes:** While `npx` (Node.js) is the recommended default for broader compatibility, an alternative using `deno` is provided below for users prioritizing enhanced security. Deno allows explicit control over script permissions (like network access) via flags such as `--allow-net`, reducing potential risks. See [#7](https://github.com/upstash/context7-mcp/issues/7) for the discussion. - ### Install in Cursor Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server` @@ -61,7 +61,23 @@ Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file i ```
-Alternative: Use Deno (Enhanced Security) +Alternative: Use Bun + +```json +{ + "mcpServers": { + "context7": { + "command": "bunx", + "args": ["-y", "@upstash/context7-mcp@latest"] + } + } +} +``` + +
+ +
+Alternative: Use Deno ```json { @@ -91,22 +107,6 @@ Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs. } ``` -
-Alternative: Use Deno (Enhanced Security) - -```json -{ - "mcpServers": { - "context7": { - "command": "deno", - "args": ["run", "--allow-net", "npm:@upstash/context7-mcp"] - } - } -} -``` - -
- ### Install in VSCode Add this to your VSCode MCP config file. See [VSCode MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info. @@ -123,23 +123,6 @@ Add this to your VSCode MCP config file. See [VSCode MCP docs](https://code.visu } ``` -
-Alternative: Use Deno (Enhanced Security) - -```json -{ - "servers": { - "Context7": { - "type": "stdio", - "command": "deno", - "args": ["run", "--allow-net", "npm:@upstash/context7-mcp"] - } - } -} -``` - -
- ### Available Tools - `resolve-library-id`: Resolves a general library name into a Context7-compatible library ID.