Skip to content

add instructions on how to test the server with VS Code #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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 to know more about my GitHub profile.
```


## TODO

Lots of things!
Expand Down
File renamed without changes.