From 4561355a6580145c2c1ec49b2b4bec76d9bf04a8 Mon Sep 17 00:00:00 2001 From: Javier Uruen Val Date: Tue, 18 Mar 2025 09:39:40 +0100 Subject: [PATCH 1/2] add instructions on how to test the server with VS Code --- README.md | 44 ++++++++++++++++++++++- cmd/{server => github-mcp-server}/main.go | 0 2 files changed, 43 insertions(+), 1 deletion(-) rename cmd/{server => github-mcp-server}/main.go (100%) diff --git a/README.md b/README.md index 3929b727e..582c2a1c1 100644 --- a/README.md +++ b/README.md @@ -184,7 +184,7 @@ and set it as the GITHUB_PERSONAL_ACCESS_TOKEN environment variable. ## Standard input/output server ```sh -go run cmd/server/main.go stdio +go run cmd/github-mcp-server/main.go stdio ``` E.g: @@ -214,6 +214,48 @@ GitHub MCP Server running on stdio ``` +## Testing on VS Code Insiders + +First of all, install `github-mcp-server` with: + +```bash +go install ./cmd/github-mcp-server +``` + +Make sure you: + +1. Set your `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable and ensure VS Code has access to it. +2. VS Code Insiders has access to the `github-mcp-server` binary + +Go to settings, find the MCP related settings, and set them to: + +```json +{ + "mcp": { + "inputs": [], + "servers": { + "mcp-github-server": { + "command": "path-to-your/github-mcp-server", + "args": [ + "stdio" + ], + "env": {} + } + } + } +} +``` + +In `Copilot Edits`, you should now see an option to reload the available `tools`. +Reload, and you should be good to go. + +Try something like the following prompt to verify that it works: + +``` +I'd like like to know more about my GitHub profile. +``` + + ## TODO Lots of things! diff --git a/cmd/server/main.go b/cmd/github-mcp-server/main.go similarity index 100% rename from cmd/server/main.go rename to cmd/github-mcp-server/main.go From d533b16638fc6899d09114320f0c3b9147394f6d Mon Sep 17 00:00:00 2001 From: Javier Uruen Val Date: Tue, 18 Mar 2025 09:42:10 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 582c2a1c1..c68eda2fb 100644 --- a/README.md +++ b/README.md @@ -252,7 +252,7 @@ Reload, and you should be good to go. Try something like the following prompt to verify that it works: ``` -I'd like like to know more about my GitHub profile. +I'd like to know more about my GitHub profile. ```