Skip to content

Commit 4c5fa8a

Browse files
committed
docs: add go install as first-class installation method
Add go install alongside Docker as a first-class installation option. go install is the idiomatic way to distribute Go CLI tools and provides a simpler experience for users who already have Go installed. Fixes #2364
1 parent dd5d5a8 commit 4c5fa8a

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,9 +362,35 @@ For a complete overview of all installation options, see our **[Installation Gui
362362

363363
> **Note:** Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
364364
365+
### Install with Go
366+
367+
If you have Go installed, you can install the server with a single command:
368+
369+
```bash
370+
go install github.com/github/github-mcp-server/cmd/github-mcp-server@latest
371+
```
372+
373+
Then configure your MCP client to use the local binary:
374+
375+
```JSON
376+
{
377+
"mcp": {
378+
"servers": {
379+
"github": {
380+
"command": "github-mcp-server",
381+
"args": ["stdio"],
382+
"env": {
383+
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
384+
}
385+
}
386+
}
387+
}
388+
}
389+
```
390+
365391
### Build from source
366392

367-
If you don't have Docker, you can use `go build` to build the binary in the
393+
If you don't have Docker or Go, you can use `go build` to build the binary in the
368394
`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:
369395

370396
```JSON

0 commit comments

Comments
 (0)