Skip to content

docs: add go install as a first-class local install method - #3745

Open
nanami7777777 wants to merge 1 commit into
github:mainfrom
nanami7777777:docs/go-install-method
Open

nanami7777777 wants to merge 1 commit into
github:mainfrom
nanami7777777:docs/go-install-method

Conversation

@nanami7777777

Copy link
Copy Markdown

Summary

  • Documents go install github.com/github/github-mcp-server/v2/cmd/github-mcp-server@latest as a first-class way to run the local server without Docker.
  • Keeps go build from a checkout for contributors who need embedded VCS metadata.
  • Points to the native-binary OAuth flow.

Fixes #2364

Notes

The issue suggested github.com/github/github-mcp-server/cmd/...@latest. That resolves to the pre-v2 module (v1.14.0). The working path is the /v2 module, verified with:

go install github.com/github/github-mcp-server/v2/cmd/github-mcp-server@latest
github-mcp-server --version

Test plan

  • go install .../v2/cmd/github-mcp-server@latest succeeds on darwin/arm64
  • README section renders correctly on GitHub
  • Maintainers OK with Go 1.27+ wording (matches current go.mod)

Made with Cursor

Make the native binary path a first-class option beside Docker, using the
v2 module path, and keep go build as the checkout-based alternative.

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Copilot was unable to run its full agentic suite in this review.

Copilot review overview

No open issues 🎉

What changed in this PR

Updates the README installation section to favor installing a native github-mcp-server binary via go install, while preserving guidance for building from a local checkout and documenting version/metadata behavior.

Changes:

  • Replaces “Build from source” with “Install with Go / build from source” and adds go install ...@latest instructions.
  • Updates the example MCP server command to use github-mcp-server from PATH instead of a hard-coded path.
  • Reintroduces local-build instructions and adds a link for OAuth login docs for native binaries.
File Description
README.md Updates native install/build instructions and related configuration guidance.

Review effort: Lite (auto)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add go install as a first-class installation method

2 participants