Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,24 @@

## Installation

### Option 1: Install Bundle (Claude Desktop)
### Option 1: Use Remote URL

Add as a connector in Claude — no installation needed:

1. Go to **claude.ai → Settings → Connectors**
2. Click **"Add custom connector"**
3. Enter URL: `https://github-mcp.maganuriyev.workers.dev/mcp`
4. (Optional) For higher rate limits (5,000 req/hr instead of 60), add a GitHub Personal Access Token:
- Go to [github.com → Settings → Developer settings → Personal access tokens → Fine-grained tokens](https://github.com/settings/personal-access-tokens/new)
- Set a descriptive name (e.g. `github-mcp`) and expiration
- Under **Repository access**, select **"Public Repositories (read-only)"**
- No additional permissions needed — the default read-only access to public repos is sufficient
- Click **Generate token** and copy it
- Back in Claude, expand **Advanced settings** and paste the token into **"OAuth Client Secret"**

Works out of the box without a PAT — unauthenticated requests use the server's default GitHub token.

### Option 2: Install Bundle (Claude Desktop)

1. Download `github-mcp.mcpb` from the [latest release](https://github.com/maganuriyev/github-mcp-worker/releases)
2. Double-click the `.mcpb` file — Claude Desktop installs it automatically
Expand All @@ -17,7 +34,7 @@
"env": { "GITHUB_PAT": "ghp_your_token_here" }
```

### Option 2: Build from Source
### Option 3: Build from Source

```bash
git clone https://github.com/maganuriyev/github-mcp-worker.git
Expand Down Expand Up @@ -47,23 +64,6 @@ GITHUB_PAT=ghp_xxx node dist/main.js --port 3001
# → http://localhost:3001/mcp
```

### Option 3: Use Remote URL

Add as a connector in Claude — no installation needed:

1. Go to **claude.ai → Settings → Connectors**
2. Click **"Add custom connector"**
3. Enter URL: `https://github-mcp.maganuriyev.workers.dev/mcp`
4. (Optional) For higher rate limits (5,000 req/hr instead of 60), add a GitHub Personal Access Token:
- Go to [github.com → Settings → Developer settings → Personal access tokens → Fine-grained tokens](https://github.com/settings/personal-access-tokens/new)
- Set a descriptive name (e.g. `github-mcp`) and expiration
- Under **Repository access**, select **"Public Repositories (read-only)"**
- No additional permissions needed — the default read-only access to public repos is sufficient
- Click **Generate token** and copy it
- Back in Claude, expand **Advanced settings** and paste the token into **"OAuth Client Secret"**

Works out of the box without a PAT — unauthenticated requests use the server's default GitHub token.

## Example Prompts

> What are some beginner-friendly open issues on huggingface/transformers that would make for easy open source contributions?
Expand Down