Skip to content

doc: add details on using OAuth to GitHub MCP in Gemini CLI #1098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+41 −3
Open

doc: add details on using OAuth to GitHub MCP in Gemini CLI #1098

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 41 additions & 3 deletions docs/installation-guides/install-gemini-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,17 @@
## Prerequisites

1. Google Gemini CLI installed (see [official Gemini CLI documentation](https://github.com/google-gemini/gemini-cli))
2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes
3. For local installation: [Docker](https://www.docker.com/) installed and running
2. When using the Remote server (Recommended), one of the following:
- a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes.

- an Client ID + Secret pair from [an OAuth App you registered on
GitHub](https://github.com/settings/developers). If you use this option,
it's important to set the callback URL for this app to the URL Gemini CLI
uses: http://localhost:7777/oauth/callback .

3. For local installation:
- [Docker](https://www.docker.com/) or [Podman](https://podman.io/) installed and running
- a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes.

<details>
<summary><b>Storing Your PAT Securely</b></summary>
Expand Down Expand Up @@ -32,7 +41,7 @@ After securely storing your PAT, you can add the GitHub MCP server configuration

### Method 1: Remote Server (Recommended)

The simplest way is to use GitHub's hosted MCP server:
The simplest way is to use GitHub's hosted MCP server. You can use it with a PAT:

```json
// ~/.gemini/settings.json
Expand All @@ -49,6 +58,27 @@ The simplest way is to use GitHub's hosted MCP server:
}
```

or with OAuth:

```json
// ~/.gemini/settings.json
{
"mcpServers": {
"github": {
"httpUrl": "https://api.githubcopilot.com/mcp/",
"trust": true,
"oauth": {
"enabled": true,
"clientId": "your-own-client-ID",
"clientSecret": "your-own-client-Secret"
}
}
}
}
```



### Method 2: Local Docker

With docker running, you can run the GitHub MCP server in a container:
Expand Down Expand Up @@ -100,6 +130,14 @@ Then, replacing `/path/to/binary` with the actual path to your binary, configure

To verify that the GitHub MCP server has been configured, start Gemini CLI in your terminal with `gemini`, then:

0. **Only if you are using OAuth**: Authenticate to the GitHub Copilot server:

```
/mcp auth github
```

Replace "github" in the above with whatever you called the server in your `mcpServers` list.

1. **Check MCP server status**:

```
Expand Down