We can't guarantee that every tool, feature, or pull request will be approved or merged. Our focus is on supporting high-quality, high-impact capabilities that advance agentic workflows and deliver clear value to developers.

To increase the chances your request is accepted:

* Include real use cases or examples that demonstrate practical value

* If your request stalls, you can open a Discussion post and link to your issue or PR

* We actively revisit requests that gain strong community engagement (👍s, comments, or evidence of real-world use)

Thanks for contributing and for helping us build toolsets that are truly valuable!

This directory contains detailed installation instructions for the GitHub MCP Server across different host applications and IDEs. Choose the guide that matches your development environment.

- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot

- **[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI

- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE

- **[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE

| Host Application | Local GitHub MCP Support | Remote GitHub MCP Support | Prerequisites | Difficulty |

|-----------------|---------------|----------------|---------------|------------|

| Copilot in VS Code | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: VS Code 1.101+ | Easy |

| Copilot Coding Agent | ✅ | ✅ Full (on by default; no auth needed) | Any _paid_ copilot license | Default on |

| Copilot in Visual Studio | ✅ | ✅ PAT + ❌ No OAuth | Local: Docker or Go build, GitHub PAT<br>Remote: Visual Studio 17.14+ | Easy |

| Copilot in JetBrains | ✅ | ✅ PAT + ❌ No OAuth | Local: Docker or Go build, GitHub PAT<br>Remote: JetBrains Copilot Extension v1.5.35+ | Easy |

| Claude Code | ✅ | ✅ PAT + ❌ No OAuth| GitHub MCP Server binary or remote URL, GitHub PAT | Easy |

| Claude Desktop | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Moderate |

| Cursor | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |

| Windsurf | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |

| Copilot in Xcode | ✅ | ✅ PAT + ❌ No OAuth | Local: Docker or Go build, GitHub PAT<br>Remote: Copilot for Xcode latest version | Easy |

| Copilot in Eclipse | ✅ | ✅ PAT + ❌ No OAuth | Local: Docker or Go build, GitHub PAT<br>Remote: TBD | Easy |

**Legend:**

- ✅ = Fully supported

- ❌ = Not yet supported

**Note:** Remote MCP support requires host applications to register a GitHub App or OAuth app for OAuth flow support – even if the new OAuth spec is supported by that host app. Currently, only VS Code has full remote GitHub server support.

The GitHub MCP Server can be installed using several methods. **Docker is the most popular and recommended approach** for most users, but alternatives are available depending on your needs:

- **Pros**: No local build required, consistent environment, easy updates, works across all platforms

- **Cons**: Requires Docker installed and running

- **Best for**: Most users, especially those already using Docker or wanting the simplest setup

- **Used by**: Claude Desktop, Copilot in VS Code, Cursor, Windsurf, etc.

- **Pros**: No Docker required, direct execution via stdio, minimal setup

- **Cons**: Need to manually download and manage updates, platform-specific binaries

- **Best for**: Minimal environments, users who prefer not to use Docker

- **Used by**: Claude Code CLI, lightweight setups

- **Pros**: Latest features, full customization, no external dependencies

- **Cons**: Requires Go development environment, more complex setup

- **Prerequisites**: [Go 1.24+](https://go.dev/doc/install)

- **Build command**: `go build -o github-mcp-server cmd/github-mcp-server/main.go`

- **Best for**: Developers who want the latest features or need custom modifications

- **Docker Image**: The official Docker image is now `ghcr.io/github/github-mcp-server`

- **npm Package**: The npm package @modelcontextprotocol/server-github is no longer supported as of April 2025

- **Remote Server**: The remote server URL is `https://api.githubcopilot.com/mcp/`

All installations with Personal Access Tokens (PAT) require:

- **GitHub Personal Access Token (PAT)**: [Create one here](https://github.com/settings/personal-access-tokens/new)

Optional (depending on installation method):

- **Docker** (for Docker-based installations): [Download Docker](https://www.docker.com/)

- **Go 1.24+** (for building from source): [Install Go](https://go.dev/doc/install)

Regardless of which installation method you choose, follow these security guidelines:

1. **Secure Token Storage**: Never commit your GitHub PAT to version control

2. **Limit Token Scope**: Only grant necessary permissions to your GitHub PAT

3. **File Permissions**: Restrict access to configuration files containing tokens

4. **Regular Rotation**: Periodically rotate your GitHub Personal Access Tokens

5. **Environment Variables**: Use environment variables when supported by your host

If you encounter issues:

1. Check the troubleshooting section in your specific installation guide

2. Verify your GitHub PAT has the required permissions

3. Ensure Docker is running (for local installations)

4. Review your host application's logs for error messages

5. Consult the main [README.md](README.md) for additional configuration options

After installation, you may want to explore:

- **Toolsets**: Enable/disable specific GitHub API capabilities

- **Read-Only Mode**: Restrict to read-only operations

- **Dynamic Tool Discovery**: Enable tools on-demand

This guide covers installation of the GitHub MCP server for Claude Code CLI, Claude Desktop, and Claude Web applications.

Claude Web supports remote MCP servers through the Integrations built-in feature.

1. Claude Pro, Team, or Enterprise account (Integrations not available on free plan)

2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)

**Note**: As of July 2025, the remote GitHub MCP Server has known compatibility issues with Claude Web. While Claude Web supports remote MCP servers from other providers (like Atlassian, Zapier, Notion), the GitHub MCP Server integration may not work reliably.

For other remote MCP servers that do work with Claude Web:

1. Go to [claude.ai](https://claude.ai) and log in

2. Click your profile icon → **Settings**

3. Navigate to **Integrations** section

4. Click **+ Add integration** or **Add More**

5. Enter the remote server URL

6. Follow the OAuth authentication flow when prompted

**Alternative**: Use Claude Desktop or Claude Code CLI for reliable GitHub MCP Server integration.

Claude Code CLI provides command-line access to Claude with MCP server integration.

1. Claude Code CLI installed

2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)

3. [Docker](https://www.docker.com/) installed and running

Run the following command to add the GitHub MCP server using Docker:

claude mcp add github -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server

Then set the environment variable:

claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=your_github_pat

Or as a single command with the token inline:

claude mcp add-json github '{"command": "docker", "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"], "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat"}}'

**Important**: The npm package `@modelcontextprotocol/server-github` is no longer supported as of April 2025. Use the official Docker image `ghcr.io/github/github-mcp-server` instead.

- Use `-s user` to add the server to your user configuration (available across all projects)

- Use `-s project` to add the server to project-specific configuration (shared via `.mcp.json`)

- Default scope is `local` (available only to you in the current project)

Run the following command to verify the installation:

claude mcp list

Claude Desktop provides a graphical interface for interacting with the GitHub MCP Server.

1. Claude Desktop installed

2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)

3. [Docker](https://www.docker.com/) installed and running

- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`

- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

- **Linux**: `~/.config/Claude/claude_desktop_config.json` (unofficial support)

Add the following to your `claude_desktop_config.json`:

{

"mcpServers": {

"github": {

"command": "docker",

"args": [

"run",

"-i",

"--rm",

"-e",

"GITHUB_PERSONAL_ACCESS_TOKEN",

"ghcr.io/github/github-mcp-server"

],

"env": {

"GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat"

}

}

}

}

**Important**: The npm package `@modelcontextprotocol/server-github` is no longer supported as of April 2025. Use the official Docker image `ghcr.io/github/github-mcp-server` instead.

Claude Desktop supports environment variable references. You can use:

{

"mcpServers": {

"github": {

"command": "docker",

"args": [

"run",

"-i",

"--rm",

"-e",

"GITHUB_PERSONAL_ACCESS_TOKEN",

"ghcr.io/github/github-mcp-server"

],

"env": {

"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"

}

}

}

}

Then set the environment variable in your system before starting Claude Desktop.

1. Open Claude Desktop

2. Go to Settings (from the Claude menu) → Developer → Edit Config

3. Add your chosen configuration

4. Save the file

5. Restart Claude Desktop

After restarting, you should see:

- An MCP icon in the Claude Desktop interface

- The GitHub server listed as "running" in Developer settings

- Currently experiencing compatibility issues with the GitHub MCP Server

- Try other remote MCP servers (Atlassian, Zapier, Notion) which work reliably

- Use Claude Desktop or Claude Code CLI as alternatives for GitHub integration

- Verify the command syntax is correct (note the single quotes around the JSON)

- Ensure Docker is running: `docker --version`

- Use `/mcp` command within Claude Code to check server status

- Check logs at:

- **macOS**: `~/Library/Logs/Claude/`

- **Windows**: `%APPDATA%\Claude\logs\`

- Look for `mcp-server-github.log` for server-specific errors

- Ensure configuration file is valid JSON

- Try running the Docker command manually in terminal to diagnose issues

- **Invalid JSON**: Validate your configuration at [jsonlint.com](https://jsonlint.com)

- **PAT issues**: Ensure your GitHub PAT has required scopes

- **Docker not found**: Install Docker Desktop and ensure it's running

- **Docker image pull fails**: Try `docker logout ghcr.io` then retry

- **Protect configuration files**: Set appropriate file permissions

- **Use environment variables** when possible instead of hardcoding tokens

- **Limit PAT scope** to only necessary permissions

- **Regularly rotate** your GitHub Personal Access Tokens

- **Never commit** configuration files containing tokens to version control

- [Model Context Protocol Documentation](https://modelcontextprotocol.io)

- [Claude Code MCP Documentation](https://docs.anthropic.com/en/docs/claude-code/mcp)

- [Claude Web Integrations Support](https://support.anthropic.com/en/articles/11175166-about-custom-integrations-using-remote-mcp)