From f229de297f5e89dbf1a2d493ac7fce38ee000dd4 Mon Sep 17 00:00:00 2001 From: Salvador Fuentes Jr Date: Tue, 8 Apr 2025 13:49:23 -0700 Subject: [PATCH 1/2] Update README.md to remove mcp key The vscode configuration example in the README.md does not work with my version of vscode. Since it's also not required, this change removes it so that it works in all versions of vscode. Version: ``` Version: 1.99.1 (Universal) Commit: 7c6fdfb0b8f2f675eb0b47f3d95eeca78962565b Date: 2025-04-04T15:58:59.624Z (4 days ago) Electron: 34.3.2 ElectronBuildId: 11161073 Chromium: 132.0.6834.210 Node.js: 20.18.3 V8: 13.2.152.41-electron.0 OS: Darwin x64 24.3.0 ``` --- README.md | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 89bb7ceb..7789bacf 100644 --- a/README.md +++ b/README.md @@ -29,37 +29,35 @@ For manual installation, add the following JSON block to your User Settings (JSO 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. -> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file. ```json { - "mcp": { - "inputs": [ - { - "type": "promptString", - "id": "github_token", - "description": "GitHub Personal Access Token", - "password": true - } - ], - "servers": { - "github": { - "command": "docker", - "args": [ - "run", - "-i", - "--rm", - "-e", - "GITHUB_PERSONAL_ACCESS_TOKEN", - "ghcr.io/github/github-mcp-server" - ], - "env": { - "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" - } + "inputs": [ + { + "type": "promptString", + "id": "github_token", + "description": "GitHub Personal Access Token", + "password": true + } + ], + "servers": { + "github": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "-e", + "GITHUB_PERSONAL_ACCESS_TOKEN", + "ghcr.io/github/github-mcp-server" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" } } } } + ``` More about using MCP server tools in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). From d858f119cfc537e090c10eeb250803b495826e81 Mon Sep 17 00:00:00 2001 From: Salvador Fuentes Jr Date: Tue, 8 Apr 2025 16:15:19 -0700 Subject: [PATCH 2/2] Add other example config snip --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7789bacf..b9ef26a0 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,38 @@ For quick installation, use one of the one-click install buttons at the top of t 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)`. -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. +```json +{ + "mcp": { + "inputs": [ + { + "type": "promptString", + "id": "github_token", + "description": "GitHub Personal Access Token", + "password": true + } + ], + "servers": { + "github": { + "command": "docker", + "args": [ + "run", + "-i", + "--rm", + "-e", + "GITHUB_PERSONAL_ACCESS_TOKEN", + "ghcr.io/github/github-mcp-server" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } + } + } + } +} +``` + +Optionally, you can add a similar example (i.e. without the mcp key) to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. ```json