Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#3,495 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

@Flanxiyum001 y travaille déjà.

Depuis le 14/10/2026.

  • #3496 par @Flanxiyum001 — ouverte

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
68/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
docker, go
Domaine
documentation

Piste de recherche

Commence par lire les sections de configuration basées sur Docker dans README.md et le document lié docs/oauth-login.md pour voir quelles options sans Docker sont déjà documentées. Ajoute une section près du début qui indique que Docker est facultatif, couvre la configuration OAuth distante ou PAT et le chemin du binaire natif go build, et renvoie vers docs/oauth-login.md. La tâche est terminée lorsque la nouvelle section se trouve près du début de README.md, que ses liens fonctionnent et que les exemples Docker ont des équivalents sans Docker ou des avertissements.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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.

Langage dominant
Go
Étoiles
33.8k
Forks
5.2k
Merge moyen
2 j 18 h
PR mergées (30 j)
38

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/github-mcp-server

Toutes les issues de github/github-mcp-server

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.