You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+74-14
Original file line number
Diff line number
Diff line change
@@ -351,40 +351,100 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
351
351
352
352
## Testing on VS Code Insiders
353
353
354
-
First of all, install `github-mcp-server` with:
354
+
### Requirements
355
+
356
+
You can either use a Docker image or build the binary from the repo.
357
+
358
+
#### Docker image
359
+
360
+
As of now, this repo is private and hence the docker image is not available publicly. To pull it,
361
+
you need to make sure you can access the GitHub docker registry. See [this](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic)
362
+
for more details.
363
+
364
+
To make sure you can access the GitHub docker registry, run the following command:
365
+
366
+
```bash
367
+
docker pull ghcr.io/github/github-mcp-server:main
368
+
```
369
+
370
+
If the above command works, you are good to go.
371
+
372
+
#### Build from repo
373
+
First of all, install `github-mcp-server` by cloning the repo and running the following command:
355
374
356
375
```bash
357
376
go install ./cmd/github-mcp-server
358
377
```
359
378
379
+
If you don't want to clone the repo, you can run:
380
+
381
+
```bash
382
+
GOPRIVATE=github.com/github go install github.com/github/github-mcp-server/cmd/github-mcp-server@latest
383
+
```
384
+
385
+
This will install the `github-mcp-server` binary in your `$GOPATH/bin` directory.
386
+
387
+
Find where the binary is installed by running:
388
+
389
+
```bash
390
+
which github-mcp-server
391
+
```
392
+
393
+
### Start VS Code Insiders
394
+
395
+
Start VS Code Insiders and make sure you pass the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable to the process.
396
+
397
+
One way to do this is to make sure that [you can run VS code from your terminal](https://code.visualstudio.com/docs/setup/mac#_launch-vs-code-from-the-command-line) and
0 commit comments