Skip to content

Commit e45d5d3

Browse files
authored
Merge pull request #57 from redis/docs/fix-mcp-config-examples
docs: fix MCP config examples to use mcp.json with top-level servers
2 parents 74c074c + 73eb2d2 commit e45d5d3

File tree

1 file changed

+15
-40
lines changed

1 file changed

+15
-40
lines changed

README.md

Lines changed: 15 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -432,25 +432,23 @@ To use the Redis MCP Server with VS Code, you must nable the [agent mode](https:
432432
}
433433
```
434434

435-
You can start the GitHub desired version of the Redis MCP server using `uvx` by adding the following JSON to your `settings.json`:
435+
You can start the GitHub desired version of the Redis MCP server using `uvx` by adding the following JSON to your `mcp.json` file:
436436

437437
```json
438-
"mcp": {
439-
"servers": {
440-
"Redis MCP Server": {
441-
"type": "stdio",
442-
"command": "uvx",
443-
"args": [
444-
"--from", "redis-mcp-server@latest",
445-
"redis-mcp-server",
446-
"--url", "redis://localhost:6379/0"
447-
]
448-
},
449-
}
450-
},
438+
"servers": {
439+
"Redis MCP Server": {
440+
"type": "stdio",
441+
"command": "uvx",
442+
"args": [
443+
"--from", "redis-mcp-server@latest",
444+
"redis-mcp-server",
445+
"--url", "redis://localhost:6379/0"
446+
]
447+
},
448+
}
451449
```
452450

453-
Alternatively, you can start the server using `uv` and configure your `mcp.json` or `settings.json`. This is usually desired for development.
451+
Alternatively, you can start the server using `uv` and configure your `mcp.json`. This is usually desired for development.
454452

455453
```json
456454
{
@@ -475,33 +473,10 @@ Alternatively, you can start the server using `uv` and configure your `mcp.json`
475473
}
476474
```
477475

478-
```json
479-
{
480-
"mcp": {
481-
"servers": {
482-
"redis": {
483-
"type": "stdio",
484-
"command": "<full_path_uv_command>",
485-
"args": [
486-
"--directory",
487-
"<your_mcp_server_directory>",
488-
"run",
489-
"src/main.py"
490-
],
491-
"env": {
492-
"REDIS_HOST": "<your_redis_database_hostname>",
493-
"REDIS_PORT": "<your_redis_database_port>",
494-
"REDIS_USERNAME": "<your_redis_database_username>",
495-
"REDIS_PWD": "<your_redis_database_password>",
496-
}
497-
}
498-
}
499-
}
500-
}
501-
```
502-
503476
For more information, see the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
504477

478+
> **Note:** Starting with [VS Code v1.102](https://code.visualstudio.com/updates/v1_102),
479+
> MCP servers are now stored in a dedicated `mcp.json` file instead of `settings.json`.
505480
506481
## Testing
507482

0 commit comments

Comments
 (0)