Skip to content

Commit 20eb595

Browse files
kunalbabrekunalbabre
committed
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
1 parent d26ee26 commit 20eb595

5 files changed

Lines changed: 96 additions & 92 deletions

File tree

‎src/everything/README.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -160,22 +160,24 @@ For quick installation, use of of the one-click install buttons below...
160160

161161
[![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)
162162

163-
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)`.
163+
For manual installation, you can configure the MCP server using one of these methods:
164164

165-
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.
165+
**Method 1: User Configuration (Recommended)**
166+
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.
166167

167-
> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
168+
**Method 2: Workspace Configuration**
169+
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.
170+
171+
> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key).
168172
169173
#### NPX
170174

171175
```json
172176
{
173-
"mcp": {
174-
"servers": {
175-
"everything": {
176-
"command": "npx",
177-
"args": ["-y", "@modelcontextprotocol/server-everything"]
178-
}
177+
"servers": {
178+
"everything": {
179+
"command": "npx",
180+
"args": ["-y", "@modelcontextprotocol/server-everything"]
179181
}
180182
}
181183
}

‎src/filesystem/README.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -201,11 +201,15 @@ For quick installation, click the installation buttons below...
201201

202202
[![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)
203203

204-
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)`.
204+
For manual installation, you can configure the MCP server using one of these methods:
205205

206-
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.
206+
**Method 1: User Configuration (Recommended)**
207+
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.
207208

208-
> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
209+
**Method 2: Workspace Configuration**
210+
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.
211+
212+
> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key).
209213
210214
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.
211215

@@ -214,19 +218,17 @@ Note: all directories must be mounted to `/projects` by default.
214218

215219
```json
216220
{
217-
"mcp": {
218-
"servers": {
219-
"filesystem": {
220-
"command": "docker",
221-
"args": [
222-
"run",
223-
"-i",
224-
"--rm",
225-
"--mount", "type=bind,src=${workspaceFolder},dst=/projects/workspace",
226-
"mcp/filesystem",
227-
"/projects"
228-
]
229-
}
221+
"servers": {
222+
"filesystem": {
223+
"command": "docker",
224+
"args": [
225+
"run",
226+
"-i",
227+
"--rm",
228+
"--mount", "type=bind,src=${workspaceFolder},dst=/projects/workspace",
229+
"mcp/filesystem",
230+
"/projects"
231+
]
230232
}
231233
}
232234
}
@@ -236,16 +238,14 @@ Note: all directories must be mounted to `/projects` by default.
236238

237239
```json
238240
{
239-
"mcp": {
240-
"servers": {
241-
"filesystem": {
242-
"command": "npx",
243-
"args": [
244-
"-y",
245-
"@modelcontextprotocol/server-filesystem",
246-
"${workspaceFolder}"
247-
]
248-
}
241+
"servers": {
242+
"filesystem": {
243+
"command": "npx",
244+
"args": [
245+
"-y",
246+
"@modelcontextprotocol/server-filesystem",
247+
"${workspaceFolder}"
248+
]
249249
}
250250
}
251251
}

‎src/git/README.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,22 @@ For quick installation, use one of the one-click install buttons below...
173173

174174
[![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)
175175

176-
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)`.
176+
For manual installation, you can configure the MCP server using one of these methods:
177177

178-
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.
178+
**Method 1: User Configuration (Recommended)**
179+
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.
179180

180-
> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
181+
**Method 2: Workspace Configuration**
182+
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.
183+
184+
> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key).
181185
182186
```json
183187
{
184-
"mcp": {
185-
"servers": {
186-
"git": {
187-
"command": "uvx",
188-
"args": ["mcp-server-git"]
189-
}
188+
"servers": {
189+
"git": {
190+
"command": "uvx",
191+
"args": ["mcp-server-git"]
190192
}
191193
}
192194
}

‎src/memory/README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -190,25 +190,27 @@ For quick installation, use one of the one-click installation buttons below:
190190

191191
[![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)
192192

193-
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)`.
193+
For manual installation, you can configure the MCP server using one of these methods:
194194

195-
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.
195+
**Method 1: User Configuration (Recommended)**
196+
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.
196197

197-
> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
198+
**Method 2: Workspace Configuration**
199+
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.
200+
201+
> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key).
198202
199203
#### NPX
200204

201205
```json
202206
{
203-
"mcp": {
204-
"servers": {
205-
"memory": {
206-
"command": "npx",
207-
"args": [
208-
"-y",
209-
"@modelcontextprotocol/server-memory"
210-
]
211-
}
207+
"servers": {
208+
"memory": {
209+
"command": "npx",
210+
"args": [
211+
"-y",
212+
"@modelcontextprotocol/server-memory"
213+
]
212214
}
213215
}
214216
}
@@ -218,19 +220,17 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace
218220

219221
```json
220222
{
221-
"mcp": {
222-
"servers": {
223-
"memory": {
224-
"command": "docker",
225-
"args": [
226-
"run",
227-
"-i",
228-
"-v",
229-
"claude-memory:/app/dist",
230-
"--rm",
231-
"mcp/memory"
232-
]
233-
}
223+
"servers": {
224+
"memory": {
225+
"command": "docker",
226+
"args": [
227+
"run",
228+
"-i",
229+
"-v",
230+
"claude-memory:/app/dist",
231+
"--rm",
232+
"mcp/memory"
233+
]
234234
}
235235
}
236236
}

‎src/sequentialthinking/README.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -88,25 +88,27 @@ For quick installation, click one of the installation buttons below...
8888

8989
[![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)
9090

91-
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)`.
91+
For manual installation, you can configure the MCP server using one of these methods:
9292

93-
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.
93+
**Method 1: User Configuration (Recommended)**
94+
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.
9495

95-
> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
96+
**Method 2: Workspace Configuration**
97+
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.
98+
99+
> Note that the `servers` object should be at the root level in `mcp.json` files (no `mcp` wrapper key).
96100
97101
For NPX installation:
98102

99103
```json
100104
{
101-
"mcp": {
102-
"servers": {
103-
"sequential-thinking": {
104-
"command": "npx",
105-
"args": [
106-
"-y",
107-
"@modelcontextprotocol/server-sequential-thinking"
108-
]
109-
}
105+
"servers": {
106+
"sequential-thinking": {
107+
"command": "npx",
108+
"args": [
109+
"-y",
110+
"@modelcontextprotocol/server-sequential-thinking"
111+
]
110112
}
111113
}
112114
}
@@ -116,17 +118,15 @@ For Docker installation:
116118

117119
```json
118120
{
119-
"mcp": {
120-
"servers": {
121-
"sequential-thinking": {
122-
"command": "docker",
123-
"args": [
124-
"run",
125-
"--rm",
126-
"-i",
127-
"mcp/sequentialthinking"
128-
]
129-
}
121+
"servers": {
122+
"sequential-thinking": {
123+
"command": "docker",
124+
"args": [
125+
"run",
126+
"--rm",
127+
"-i",
128+
"mcp/sequentialthinking"
129+
]
130130
}
131131
}
132132
}

0 commit comments

Comments
 (0)