Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#3,495 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

@Flanxiyum001 is already working on this.

Since Oct 14, 2026.

  • #3496 by @Flanxiyum001 — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
docker, go
Domain
documentation

Research direction

Start by reading the Docker-based setup sections in README.md and the linked docs/oauth-login.md to see which no-Docker options are already documented. Add a near-top section that states Docker is optional, covers the remote OAuth or PAT setup and the go build native binary path, and links to docs/oauth-login.md. Done when the new section sits near the top of README.md, its links resolve, and the Docker examples have non-Docker equivalents or callouts.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Go
Stars
33.8k
Forks
5.2k
Avg merge
2d 21h
Merged PRs (30d)
39

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/github-mcp-server

All issues in github/github-mcp-server

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.