Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Add Zero-Docker quick start and clarify no‑Docker options in README

未关闭 适合新手
#3,495 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

@Flanxiyum001 已经在做这个了。

开始于 2026年10月14日。

  • #3496 来自 @Flanxiyum001 —— 未关闭

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
68/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
docker, go
领域
documentation

调研方向

先阅读 README.md 中基于 Docker 的安装配置部分以及链接的 docs/oauth-login.md,看看哪些非 Docker 方案已有文档。在靠近顶部的位置添加一个小节,说明 Docker 是可选的,涵盖远程 OAuth 或 PAT 配置以及使用 go build 构建原生二进制的路径,并链接到 docs/oauth-login.md。完成标准是:新小节位于 README.md 顶部附近,链接均可访问,并且 Docker 示例都有非 Docker 的等效方案或说明。

由索引模型根据 Issue 内容生成。

描述

documentation

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

  1. 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-server binary using go build and stdio with a GITHUB_PERSONAL_ACCESS_TOKEN
  2. 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

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/github-mcp-server 的其他 Issue

查看 github/github-mcp-server 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。