From 15230150a227d36b8b8c9e683f77a3bf02edec91 Mon Sep 17 00:00:00 2001 From: Ricardo Fearing <9965014+rfearing@users.noreply.github.com> Date: Mon, 14 Apr 2025 14:59:37 +0000 Subject: [PATCH] Clarify local build --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ec8018a0f..6bfc6ab58 100644 --- a/README.md +++ b/README.md @@ -91,10 +91,24 @@ More about using MCP server tools in VS Code's [agent mode documentation](https: ### Build from source -If you don't have Docker, you can use `go` to build the binary in the -`cmd/github-mcp-server` directory, and use the `github-mcp-server stdio` -command with the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable set to -your token. +If you don't have Docker, you can use `go build` to build the binary in the +`cmd/github-mcp-server` directory, and use the `github-mcp-server stdio` command with the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable set to your token. To specify the output location of the build, use the `-o` flag. You should configure your server to use the built executable as its `command`. For example: + +```JSON +{ + "mcp": { + "servers": { + "github": { + "command": "/path/to/github-mcp-server", + "args": ["stdio"], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "" + } + } + } + } +} +``` ## GitHub Enterprise Server