# GitHub (read-only) MCP server

Read-only GitHub repos, issues, PRs and commits, with tool descriptions tuned on a benchmark.

## At a glance

GitHub (read-only) is an MCP server in the Dev Tools & Git category. It runs locally over stdio via `uvx github-mcp-readonly`, and needs GITHUB_TOKEN. It exposes 3 tools, including server.py, descriptions.py and github_client.py. It scores B (76/100) on the MCP Skills Hub health score as of Oct 28, 2026.

## Install

### How to install GitHub (read-only) in Claude Code

1. Add the server

```bash
claude mcp add github-mcp -e 'GITHUB_TOKEN=<GITHUB_TOKEN>' -- uvx github-mcp-readonly
```

2. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

3. Verify it's connected

```bash
claude mcp list
```

4. Sharing it with your team?

   Add `--scope project` to write it to .mcp.json in the repository root, which you can commit (with the secrets left as environment variables).

5. Use it in a session

   Ask Claude to use the tools this server exposes (e.g. server.py, descriptions.py, github_client.py). It discovers them automatically.

### How to install GitHub (read-only) in Claude Desktop

1. Open your MCP config

   macOS: ~/Library/Application Support/Claude/claude_desktop_config.json · Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Add this server

```json
{
  "mcpServers": {
    "github-mcp": {
      "command": "uvx",
      "args": [
        "github-mcp-readonly"
      ],
      "env": {
        "GITHUB_TOKEN": "<GITHUB_TOKEN>"
      }
    }
  }
}
```

3. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

4. Restart Claude Desktop

   The tools appear under the 🔌 menu once the app reloads.

### How to install GitHub (read-only) in Cursor

1. Create / edit .cursor/mcp.json in your project

```json
{
  "mcpServers": {
    "github-mcp": {
      "command": "uvx",
      "args": [
        "github-mcp-readonly"
      ],
      "env": {
        "GITHUB_TOKEN": "<GITHUB_TOKEN>"
      }
    }
  }
}
```

2. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

3. Enable it

   Cursor Settings → MCP → toggle the server on. Tools become available to the Composer/Agent.

### How to install GitHub (read-only) in Codex CLI

1. Add to ~/.codex/config.toml

```toml
[mcp_servers.github-mcp]
command = "uvx"
args = ["github-mcp-readonly"]
env = { GITHUB_TOKEN = "<GITHUB_TOKEN>" }
```

2. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

3. Run Codex

   Codex loads MCP servers from config.toml on startup and exposes their tools to the agent.

### How to install GitHub (read-only) in Windsurf

1. Edit ~/.codeium/windsurf/mcp_config.json

```json
{
  "mcpServers": {
    "github-mcp": {
      "command": "uvx",
      "args": [
        "github-mcp-readonly"
      ],
      "env": {
        "GITHUB_TOKEN": "<GITHUB_TOKEN>"
      }
    }
  }
}
```

2. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

3. Reload

   Windsurf → Cascade → refresh MCP servers. Cascade can now call the tools.

### How to install GitHub (read-only) in Cline

1. Open Cline → MCP Servers → Configure

   Adds to cline_mcp_settings.json.

2. Add the server

```json
{
  "mcpServers": {
    "github-mcp": {
      "command": "uvx",
      "args": [
        "github-mcp-readonly"
      ],
      "env": {
        "GITHUB_TOKEN": "<GITHUB_TOKEN>"
      }
    }
  }
}
```

3. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

### How to install GitHub (read-only) in VS Code

1. Create .vscode/mcp.json

```json
{
  "servers": {
    "github-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "github-mcp-readonly"
      ],
      "env": {
        "GITHUB_TOKEN": "<GITHUB_TOKEN>"
      }
    }
  }
}
```

2. Fill in your credentials

   Replace <GITHUB_TOKEN> with your real value. Keep secrets out of any config file you commit.

3. Start it

   VS Code shows a ▶ Start action above the server entry. Agent mode (Copilot Chat) can then use the tools.

## Tools

- `server.py` — Registers tools, validates arguments, returns compact JSON with exact totals
- `descriptions.py` — Versioned descriptions (`v1` baseline, `v1b` ablation, `v2` optimized, or a JSON file)
- `github_client.py` — Auth, pagination, retries, rate limits, ETag cache, typed errors

Source repository: https://github.com/AbdulMuhaiminKhan/github-mcp

---

Source: https://mcp-skills-hub.vercel.app/mcps/io-github-abdulmuhaiminkhan-github-mcp · MCP Skills Hub · data as of 2026-10-28T12:31:05Z
