Skip to content

README is missing GitHub Copilot authentication requirement #555

Open
@ejones-unity

Description

@ejones-unity

Problem

When setting up the GitHub MCP Server, the README doesn't clearly mention that you need to be authenticated against GitHub Copilot. This causes confusion during setup because:

  1. The remote server URL () hints at the Copilot requirement, but it's not explicitly documented
  2. Users may encounter authentication errors without understanding why
  3. The setup process requires trial and error to figure out the authentication dependency

Expected behavior

The README should clearly document:

  • That GitHub Copilot authentication/subscription is required for the remote server
  • How to authenticate with GitHub Copilot if needed
  • Any prerequisites related to Copilot access

Current behavior

Users have to figure out the Copilot authentication requirement through trial and error by:

  • Noticing the domain in the configuration
  • Encountering authentication failures
  • Deducing the requirement from error messages

Suggested solution

Add a clear note in the Prerequisites section mentioning the GitHub Copilot authentication requirement for the remote server option.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions