Add Zero-Docker quick start and clarify no‑Docker options in README
維護者通常 2 天內回覆
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 68/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 活躍
- 技術堆疊
- docker, go
研究方向
先閱讀 README.md 中基於 Docker 的安裝設定段落,以及連結的 docs/oauth-login.md,看看哪些非 Docker 方案已有文件說明。在靠近頂部的位置新增一個小節,說明 Docker 是可選的,涵蓋遠端 OAuth 或 PAT 設定,以及使用 go build 建置原生二進位檔的路徑,並連結到 docs/oauth-login.md。完成標準是:新小節位於 README.md 頂部附近,連結皆可正常存取,且 Docker 範例都有非 Docker 的等效做法或說明。
由索引模型根據 Issue 內容生成。
描述
Problem
The README currently emphasizes Docker as the primary way to run the GitHub MCP Server. Many users (and the original issue reporter) assume Docker is required, which raises the barrier to entry. The project already supports no‑Docker usage (remote OAuth/PAT server and a native Go binary), but this is not surfaced clearly enough.
Proposed solution
- Add a prominent “Zero-Docker quick start” section near the top of README.md that explicitly states Docker is optional and documents two no‑Docker options:
- Use the hosted remote MCP server via OAuth (recommended for supported hosts)
- Build and run the native
github-mcp-serverbinary usinggo buildandstdiowith a GITHUB_PERSONAL_ACCESS_TOKEN
- Update examples that currently show Docker-based commands to include equivalent non-Docker examples (or callouts) and link to the new section and docs/oauth-login.md.
Files to change
- README.md (primary)
- Optionally: docs/oauth-login.md (ensure link targets and examples are consistent)
Proposed branch and PR
- Branch name: feat/zero-docker-quickstart
- PR title: Add Zero-Docker quick start and clarify no‑Docker options in README
- PR description: summary of change, link to this issue, and that this is a docs-only change (no code changes). Include the exact instructions and JSON snippets for the two no-Docker flows.
Patch (suggested README addition)
Add a new section near the top like:
"""
Zero-Docker quick start
You do not need Docker to use the GitHub MCP Server.
The recommended no-Docker setup is to use the remote GitHub MCP Server with OAuth or a GitHub PAT. This avoids installing Docker, avoids keeping a background container running, and works in supported MCP hosts such as VS Code, Cursor, Windsurf, and other compatible editors.
If your MCP host supports remote servers, prefer this configuration:
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/"
}
}
}
Or, if you prefer explicit authentication with a personal access token:
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "github_mcp_pat",
"description": "GitHub Personal Access Token",
"password": true
}
]
}
If your host does not support remote MCP servers, you can still run the server without Docker by building the native binary from source and launching it directly with GITHUB_PERSONAL_ACCESS_TOKEN.
"""
How I will proceed
I will create this issue now and attach the above proposed content. I can also prepare the full patch and exact git/gh commands you can run locally to create the branch, commit, push, and open the PR. I can attempt to create the branch and PR from this session, but previous attempts failed due to repository permissions — if you want me to try I will, otherwise please tell me to provide the patch and commands for you to run.
- 主要語言
- Go
- 星號
- 33.8k
- 分支
- 5.2k
- 平均合併
- 2 天 18 小時
- 30 天內合併 PR
- 38
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
github/github-mcp-server 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 75/100
github/github-mcp-server#3581 ·
維護者通常 2 天內回覆
-
難度 1/5 1 小時以內 新手友好度 90/100
github/github-mcp-server#3578 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 85/100
github/github-mcp-server#3572 ·
維護者通常 2 天內回覆
-
Integer parameters equal to 2^63 pass the range check in toInt and wrap to a negative number可能已有人在做 @xiao115255 於 11 天前認領。 未關閉bug
難度 2/5 1-3 小時 新手友好度 82/100
github/github-mcp-server#3489 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
github/github-mcp-server#3475 ·
維護者通常 2 天內回覆
查看 github/github-mcp-server 的全部 Issue
相似的 Issue
-
agent-review-finding chore
難度 1/5 1 小時以內 新手友好度 85/100
jordansmall/spindrift#6033 ·
維護者通常 1 天內回覆
-
enhancement
難度 2/5 1-3 小時 新手友好度 75/100
hyperledger/fabric-x-common#230 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 半天 新手友好度 65/100
open-wanderer/wanderer#1443 · 3 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 75/100
維護者通常 1 天內回覆
-
area/backend backlog bug
難度 2/5 1-3 小時 新手友好度 85/100
praetorianer777/Stator#534 ·
維護者通常 1 天內回覆