From 20eb59590ec17f6e262aa840a1c4437c028115c8 Mon Sep 17 00:00:00 2001 From: Kunal Babre Date: Fri, 11 Jul 2025 21:36:21 -0700 Subject: [PATCH] docs: Update VS Code installation instructions to use mcp.json - Replace outdated 'Preferences: Open Settings (JSON)' instructions - Add proper guidance for 'MCP: Open User Configuration' command - Update JSON examples to remove mcp wrapper key - Clarify user vs workspace configuration methods - Fixes issue with outdated documentation across all servers Affects: sequentialthinking, filesystem, memory, everything, git --- src/everything/README.md | 20 ++++++------ src/filesystem/README.md | 52 ++++++++++++++++---------------- src/git/README.md | 20 ++++++------ src/memory/README.md | 50 +++++++++++++++--------------- src/sequentialthinking/README.md | 46 ++++++++++++++-------------- 5 files changed, 96 insertions(+), 92 deletions(-) diff --git a/src/everything/README.md b/src/everything/README.md index 3ab3299a..7865128b 100644 --- a/src/everything/README.md +++ b/src/everything/README.md @@ -160,22 +160,24 @@ For quick installation, use of of the one-click install buttons below... [![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=everything&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22mcp%2Feverything%22%5D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=everything&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22mcp%2Feverything%22%5D%7D&quality=insiders) -For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`. +For manual installation, you can configure the MCP server using one of these methods: -Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. +**Method 1: User Configuration (Recommended)** +Add the configuration to your user-level MCP configuration file. Open the Command Palette (`Ctrl + Shift + P`) and run `MCP: Open User Configuration`. This will open your user `mcp.json` file where you can add the server configuration. -> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file. +**Method 2: Workspace Configuration** +Alternatively, you can add the configuration to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. + +> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key). #### NPX ```json { - "mcp": { - "servers": { - "everything": { - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-everything"] - } + "servers": { + "everything": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-everything"] } } } diff --git a/src/filesystem/README.md b/src/filesystem/README.md index cd6d0a9f..3ba3950b 100644 --- a/src/filesystem/README.md +++ b/src/filesystem/README.md @@ -201,11 +201,15 @@ For quick installation, click the installation buttons below... [![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=filesystem&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fprojects%2Fworkspace%22%2C%22mcp%2Ffilesystem%22%2C%22%2Fprojects%22%5D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=filesystem&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fprojects%2Fworkspace%22%2C%22mcp%2Ffilesystem%22%2C%22%2Fprojects%22%5D%7D&quality=insiders) -For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open Settings (JSON)`. +For manual installation, you can configure the MCP server using one of these methods: -Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. +**Method 1: User Configuration (Recommended)** +Add the configuration to your user-level MCP configuration file. Open the Command Palette (`Ctrl + Shift + P`) and run `MCP: Open User Configuration`. This will open your user `mcp.json` file where you can add the server configuration. -> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file. +**Method 2: Workspace Configuration** +Alternatively, you can add the configuration to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. + +> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key). You can provide sandboxed directories to the server by mounting them to `/projects`. Adding the `ro` flag will make the directory readonly by the server. @@ -214,19 +218,17 @@ Note: all directories must be mounted to `/projects` by default. ```json { - "mcp": { - "servers": { - "filesystem": { - "command": "docker", - "args": [ - "run", - "-i", - "--rm", - "--mount", "type=bind,src=${workspaceFolder},dst=/projects/workspace", - "mcp/filesystem", - "/projects" - ] - } + "servers": { + "filesystem": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "--mount", "type=bind,src=${workspaceFolder},dst=/projects/workspace", + "mcp/filesystem", + "/projects" + ] } } } @@ -236,16 +238,14 @@ Note: all directories must be mounted to `/projects` by default. ```json { - "mcp": { - "servers": { - "filesystem": { - "command": "npx", - "args": [ - "-y", - "@modelcontextprotocol/server-filesystem", - "${workspaceFolder}" - ] - } + "servers": { + "filesystem": { + "command": "npx", + "args": [ + "-y", + "@modelcontextprotocol/server-filesystem", + "${workspaceFolder}" + ] } } } diff --git a/src/git/README.md b/src/git/README.md index 8edf2124..7330b5fc 100644 --- a/src/git/README.md +++ b/src/git/README.md @@ -173,20 +173,22 @@ For quick installation, use one of the one-click install buttons below... [![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=git&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fworkspace%22%2C%22mcp%2Fgit%22%5D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=git&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fworkspace%22%2C%22mcp%2Fgit%22%5D%7D&quality=insiders) -For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open Settings (JSON)`. +For manual installation, you can configure the MCP server using one of these methods: -Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. +**Method 1: User Configuration (Recommended)** +Add the configuration to your user-level MCP configuration file. Open the Command Palette (`Ctrl + Shift + P`) and run `MCP: Open User Configuration`. This will open your user `mcp.json` file where you can add the server configuration. -> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file. +**Method 2: Workspace Configuration** +Alternatively, you can add the configuration to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. + +> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key). ```json { - "mcp": { - "servers": { - "git": { - "command": "uvx", - "args": ["mcp-server-git"] - } + "servers": { + "git": { + "command": "uvx", + "args": ["mcp-server-git"] } } } diff --git a/src/memory/README.md b/src/memory/README.md index 5b18d841..7f6f5d97 100644 --- a/src/memory/README.md +++ b/src/memory/README.md @@ -190,25 +190,27 @@ For quick installation, use one of the one-click installation buttons below: [![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22-v%22%2C%22claude-memory%3A%2Fapp%2Fdist%22%2C%22--rm%22%2C%22mcp%2Fmemory%22%5D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22-v%22%2C%22claude-memory%3A%2Fapp%2Fdist%22%2C%22--rm%22%2C%22mcp%2Fmemory%22%5D%7D&quality=insiders) -For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open Settings (JSON)`. +For manual installation, you can configure the MCP server using one of these methods: -Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. +**Method 1: User Configuration (Recommended)** +Add the configuration to your user-level MCP configuration file. Open the Command Palette (`Ctrl + Shift + P`) and run `MCP: Open User Configuration`. This will open your user `mcp.json` file where you can add the server configuration. -> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file. +**Method 2: Workspace Configuration** +Alternatively, you can add the configuration to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. + +> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key). #### NPX ```json { - "mcp": { - "servers": { - "memory": { - "command": "npx", - "args": [ - "-y", - "@modelcontextprotocol/server-memory" - ] - } + "servers": { + "memory": { + "command": "npx", + "args": [ + "-y", + "@modelcontextprotocol/server-memory" + ] } } } @@ -218,19 +220,17 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace ```json { - "mcp": { - "servers": { - "memory": { - "command": "docker", - "args": [ - "run", - "-i", - "-v", - "claude-memory:/app/dist", - "--rm", - "mcp/memory" - ] - } + "servers": { + "memory": { + "command": "docker", + "args": [ + "run", + "-i", + "-v", + "claude-memory:/app/dist", + "--rm", + "mcp/memory" + ] } } } diff --git a/src/sequentialthinking/README.md b/src/sequentialthinking/README.md index fd90b9b1..3be6b3c6 100644 --- a/src/sequentialthinking/README.md +++ b/src/sequentialthinking/README.md @@ -88,25 +88,27 @@ For quick installation, click one of the installation buttons below... [![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=sequentialthinking&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22mcp%2Fsequentialthinking%22%5D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=sequentialthinking&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22mcp%2Fsequentialthinking%22%5D%7D&quality=insiders) -For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open Settings (JSON)`. +For manual installation, you can configure the MCP server using one of these methods: -Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. +**Method 1: User Configuration (Recommended)** +Add the configuration to your user-level MCP configuration file. Open the Command Palette (`Ctrl + Shift + P`) and run `MCP: Open User Configuration`. This will open your user `mcp.json` file where you can add the server configuration. -> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file. +**Method 2: Workspace Configuration** +Alternatively, you can add the configuration to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. + +> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key). For NPX installation: ```json { - "mcp": { - "servers": { - "sequential-thinking": { - "command": "npx", - "args": [ - "-y", - "@modelcontextprotocol/server-sequential-thinking" - ] - } + "servers": { + "sequential-thinking": { + "command": "npx", + "args": [ + "-y", + "@modelcontextprotocol/server-sequential-thinking" + ] } } } @@ -116,17 +118,15 @@ For Docker installation: ```json { - "mcp": { - "servers": { - "sequential-thinking": { - "command": "docker", - "args": [ - "run", - "--rm", - "-i", - "mcp/sequentialthinking" - ] - } + "servers": { + "sequential-thinking": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "mcp/sequentialthinking" + ] } } }