docs(github-mcp-proxy-demo): make local binary the primary recipe, Docker an alternative#104
Conversation
📝 WalkthroughWalkthroughThis PR updates the GitHub MCP proxy demo's documentation and example configuration to make a locally-built ChangesDemo Setup and Configuration Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…cker an alternative The original PR #103 framed Docker as a hard prerequisite. That contradicts Vaara's design intent: the proxy is light tooling that spawns any MCP-stdio binary as a subprocess and doesn't depend on external runtimes. Updates the README and example config so the primary recipe uses the github-mcp-server binary directly (go install github.com/github/github-mcp-server/cmd/github-mcp-server@latest). Docker is now an alternative paragraph and a sibling _alternative_docker block in the example JSON for readers who already run Docker. The binary path is what was actually verified end-to-end during smoke testing: real github-mcp-server stdio subprocess, 42 tools advertised on tools/list, full hash-chained audit trail (action_requested -> risk_scored -> decision_made -> outcome_recorded) recorded in the SQLite DB for a tools/call request.
2af9da2 to
04c4049
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
examples/github-mcp-proxy-demo/README.md (1)
146-146: 💤 Low valueConsider clarifying the binary location guidance.
The troubleshooting mentions
$(go env GOBIN)or$(go env GOPATH)/bin, which are shell command substitutions. Consider adding a brief note for users unfamiliar with Go, such as: "Rungo env GOBINto see the install directory, orgo env GOPATHif GOBIN is not set (the binary will be in thebinsubdirectory)."🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@examples/github-mcp-proxy-demo/README.md` at line 146, Update the troubleshooting line for github-mcp-server to clarify how to find the install directory: when mentioning $(go env GOBIN) and $(go env GOPATH)/bin, add a short note telling users to run `go env GOBIN` to display the install directory and, if GOBIN is empty, run `go env GOPATH` and use the bin subdirectory (i.e., "$(go env GOPATH)/bin") so readers know how to locate the installed github-mcp-server binary.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@examples/github-mcp-proxy-demo/README.md`:
- Line 146: Update the troubleshooting line for github-mcp-server to clarify how
to find the install directory: when mentioning $(go env GOBIN) and $(go env
GOPATH)/bin, add a short note telling users to run `go env GOBIN` to display the
install directory and, if GOBIN is empty, run `go env GOPATH` and use the bin
subdirectory (i.e., "$(go env GOPATH)/bin") so readers know how to locate the
installed github-mcp-server binary.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: e4b4447c-e516-4769-a981-29550415b40c
📒 Files selected for processing (2)
examples/github-mcp-proxy-demo/README.mdexamples/github-mcp-proxy-demo/claude_code_config.example.json
Summary
Follow-up to #103. The original demo framed Docker as a hard prerequisite, which contradicts Vaara's design intent: the proxy is light tooling that spawns any MCP-stdio binary as a subprocess and shouldn't pull in external runtimes by default.
This PR makes the local binary path the primary recipe and demotes Docker to an alternative paragraph.
Changes
go install github.com/github/github-mcp-server/cmd/github-mcp-server@latest, which produces a stdio-capable binary with no external runtime.command: /path/to/github-mcp-serverwithargs: ["stdio"].github-via-vaaraentry uses the binary path. The Docker-wrapped variant is preserved as a sibling_alternative_dockerblock for readers who already run Docker.docker: command not foundentry with thego installinstruction.Verification
The binary path is what was actually verified end-to-end during smoke testing against the real
github/github-mcp-server:stdiomode as a subprocessinitializehandshake completedtools/listreturned all 42 real GitHub MCP toolstools/call search_repositorieswas intercepted, scored allow (risk 0.113, [0.000, 0.302]), forwarded to upstreamaction_requested->risk_scored->decision_made->outcome_recorded, each linked to the previous via SHA-256Docs-only. No code changes, no test changes.
Summary by CodeRabbit
github-mcp-serverbinary as an alternative to Docker.