You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+53-4Lines changed: 53 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,8 @@ Built for developers who want to connect their AI tools to GitHub context and ca
22
22
23
23
The remote GitHub MCP Server is hosted by GitHub and provides the easiest method for getting up and running. If your MCP host does not support remote MCP servers, don't worry! You can use the [local version of the GitHub MCP Server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) instead.
24
24
25
+
> **Note:** The remote server does not support OAuth device flow authentication. For OAuth authentication, use the [local GitHub MCP Server](#local-github-mcp-server) with the [OAuth authentication guide](/docs/oauth-authentication.md).
26
+
25
27
### Prerequisites
26
28
27
29
1. A compatible MCP host with remote server support (VS Code 1.101+, Claude Desktop, Cursor, Windsurf, etc.)
@@ -130,10 +132,57 @@ GitHub Enterprise Server does not support remote server hosting. Please refer to
130
132
131
133
### Prerequisites
132
134
133
-
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
134
-
2. Once Docker is installed, you will also need to ensure Docker is running. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`.
135
-
3. Lastly you will need to [Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new).
136
-
The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
1. Docker installed and running (or build from source)
137
+
2. A web browser to complete authentication
138
+
3. Network access to GitHub.com (or your GitHub Enterprise instance)
139
+
140
+
**For Personal Access Token (PAT) Authentication:**
141
+
1. Docker installed and running (or build from source)
142
+
2.[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate permissions
143
+
144
+
> **💡 Tip**: New users should try [OAuth device flow authentication](/docs/oauth-authentication.md) first - it requires no pre-configuration! Simply start the server without a token and authenticate through your browser. See the [authentication guide](/docs/oauth-authentication.md) for detailed instructions.
145
+
146
+
### Authentication Methods
147
+
148
+
The local GitHub MCP Server supports two authentication methods:
149
+
150
+
#### 1. OAuth Device Flow (Recommended for Interactive Use)
151
+
152
+
No pre-configuration needed! Start the server without a token:
The server will guide you through browser-based authentication when you first use it. [Learn more in the OAuth authentication guide](/docs/oauth-authentication.md).
164
+
165
+
#### 2. Personal Access Token (For Automation & Offline Use)
166
+
167
+
Create a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) and configure it:
See the [OAuth vs PAT comparison](/docs/oauth-authentication.md#comparison-with-pat-authentication) to choose the best method for your use case.
182
+
183
+
### Personal Access Token Configuration
184
+
185
+
If you choose to use a Personal Access Token, the MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
137
186
138
187
<details><summary><b>Handling PATs Securely</b></summary>
0 commit comments