Skip to content

Commit b2e869d

Browse files
authored
Merge pull request #17 from github/juruen/vscode-install
add instructions on how to test the server with VS Code
2 parents e0bffe9 + d533b16 commit b2e869d

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ and set it as the GITHUB_PERSONAL_ACCESS_TOKEN environment variable.
184184
## Standard input/output server
185185

186186
```sh
187-
go run cmd/server/main.go stdio
187+
go run cmd/github-mcp-server/main.go stdio
188188
```
189189

190190
E.g:
@@ -214,6 +214,48 @@ GitHub MCP Server running on stdio
214214
215215
```
216216
217+
## Testing on VS Code Insiders
218+
219+
First of all, install `github-mcp-server` with:
220+
221+
```bash
222+
go install ./cmd/github-mcp-server
223+
```
224+
225+
Make sure you:
226+
227+
1. Set your `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable and ensure VS Code has access to it.
228+
2. VS Code Insiders has access to the `github-mcp-server` binary
229+
230+
Go to settings, find the MCP related settings, and set them to:
231+
232+
```json
233+
{
234+
"mcp": {
235+
"inputs": [],
236+
"servers": {
237+
"mcp-github-server": {
238+
"command": "path-to-your/github-mcp-server",
239+
"args": [
240+
"stdio"
241+
],
242+
"env": {}
243+
}
244+
}
245+
}
246+
}
247+
```
248+
249+
In `Copilot Edits`, you should now see an option to reload the available `tools`.
250+
Reload, and you should be good to go.
251+
252+
Try something like the following prompt to verify that it works:
253+
254+
```
255+
I'd like to know more about my GitHub profile.
256+
```
257+
258+
217259
## TODO
218260
219261
Lots of things!
File renamed without changes.

0 commit comments

Comments
 (0)