Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#3,495 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

@Flanxiyum001 đang làm issue này rồi.

Từ ngày 14/10/2026.

  • #3496 của @Flanxiyum001 — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, go
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách đọc các mục thiết lập dựa trên Docker trong README.md và tài liệu docs/oauth-login.md được liên kết, để xem những tùy chọn không dùng Docker nào đã có trong tài liệu. Thêm một mục gần đầu README.md nêu rằng Docker là tùy chọn, bao gồm thiết lập OAuth từ xa hoặc PAT và đường dẫn tệp nhị phân gốc bằng go build, đồng thời liên kết đến docs/oauth-login.md. Hoàn thành khi mục mới nằm gần đầu README.md, các liên kết hoạt động, và các ví dụ Docker có phần tương đương không dùng Docker hoặc có ghi chú.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Go
Star
33.8k
Fork
5.2k
Merge trung bình
2 ngày 18 giờ
Pull request đã merge (30 ngày)
38

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/github-mcp-server

Tất cả issue của github/github-mcp-server

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.