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: content/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server.md
+196-1Lines changed: 196 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,8 +14,15 @@ redirect_from:
14
14
>[!NOTE]
15
15
> The {% data variables.product.github %} MCP server is currently in {% data variables.release-phases.public_preview %} and subject to change.
16
16
17
+
{% vscode %}
18
+
17
19
{% data reusables.copilot.mcp.about-github-mcp-server %}
18
20
21
+
## Prerequisites
22
+
23
+
* A {% data variables.product.github %} account.
24
+
* {% data variables.product.prodname_vscode %}, or another MCP-compatible editor.
25
+
19
26
## Setting up the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}
20
27
21
28
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}. Other MCP-compatible editors may have similar steps, but the exact process may vary.
@@ -187,13 +194,201 @@ The {% data variables.product.github %} MCP server enables you to perform a wide
187
194
{% data reusables.copilot.open-chat-vs-code %}
188
195
{% data reusables.copilot.select-agent %}
189
196
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the **Select tools** icon.
190
-
* In the **Tools** dropdown, under **MCP Server:{% data variables.product.github %}**, you will see a list of available actions.
197
+
* In the **Tools** dropdown, under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions.
198
+
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
199
+
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
200
+
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
201
+
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
202
+
1. Follow the prompts to complete the action.
203
+
204
+
{% endvscode %}
205
+
206
+
{% jetbrains %}
207
+
208
+
{% data reusables.copilot.mcp.about-github-mcp-server %}
209
+
210
+
## Prerequisites
211
+
212
+
* **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %}
213
+
* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot %} is compatible with the following IDEs:
214
+
215
+
{% data reusables.copilot.jetbrains-compatible-ides %}
216
+
{% data reusables.copilot.jetbrains-plugin-prerequisites %}
217
+
218
+
## Setting up the {% data variables.product.github %} MCP server in JetBrains IDEs
219
+
220
+
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in JetBrains IDEs. Other MCP-compatible editors may have similar steps, but the exact process may vary.
221
+
222
+
We recommend setting up the {% data variables.product.github %} MCP server remotely. JetBrains IDEs only support using a {% data variables.product.pat_generic %} (PAT) for authentication with the {% data variables.product.github %} MCP server.
223
+
224
+
> [!NOTE]
225
+
> If you are an {% data variables.product.prodname_emu %} with PAT restrictions, you won't be able to use PAT authentication.
226
+
227
+
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
228
+
229
+
### Remote MCP server configuration with PAT
230
+
231
+
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
232
+
233
+
1. In the lower right corner, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %}**.
234
+
1. From the menu, select "Edit settings".
235
+
1. Under the MCP section, click "Edit in `mcp.json`".
236
+
1. Add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created:
237
+
238
+
```json copy
239
+
{
240
+
"servers": {
241
+
"github": {
242
+
"url": "https://api.githubcopilot.com/mcp/",
243
+
"requestInit": {
244
+
"headers": {
245
+
"Authorization": "Bearer YOUR_GITHUB_PAT"
246
+
}
247
+
}
248
+
}
249
+
}
250
+
}
251
+
```
252
+
253
+
## Using the {% data variables.product.github %} MCP server in JetBrains IDEs
254
+
255
+
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in JetBrains IDEs.
256
+
257
+
1. Open the {% data variables.copilot.copilot_chat_short %} window by clicking the **{% data variables.copilot.copilot_chat %}** icon at the right side of the JetBrains IDE window.
258
+
259
+

260
+
1. At the top of the chat panel, click the **Agent** tab.
261
+
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon.
262
+
* Under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions.
191
263
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
192
264
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
193
265
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
194
266
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
195
267
1. Follow the prompts to complete the action.
196
268
269
+
{% endjetbrains %}
270
+
271
+
{% xcode %}
272
+
273
+
{% data reusables.copilot.mcp.about-github-mcp-server %}
274
+
275
+
## Prerequisites
276
+
277
+
***Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %}
278
+
***{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment).
279
+
280
+
## Setting up the {% data variables.product.github %} MCP server in Xcode
281
+
282
+
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in Xcode. Other MCP-compatible editors may have similar steps, but the exact process may vary.
283
+
284
+
We recommend setting up the {% data variables.product.github %} MCP server remotely. Xcode only supports using a {% data variables.product.pat_generic %} (PAT) for authentication with the {% data variables.product.github %} MCP server.
285
+
286
+
> [!NOTE]
287
+
> If you are an {% data variables.product.prodname_emu %} with PAT restrictions, you won't be able to use PAT authentication.
288
+
289
+
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
290
+
291
+
### Remote MCP server configuration with PAT
292
+
293
+
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
294
+
295
+
1. Open the {% data variables.product.prodname_copilot %} for Xcode extension.
296
+
1. In agent mode, click the tools icon.
297
+
1. Select "Edit config".
298
+
1. Add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created:
299
+
300
+
```json copy
301
+
{
302
+
"servers": {
303
+
"github": {
304
+
"url": "https://api.githubcopilot.com/mcp/",
305
+
"requestInit": {
306
+
"headers": {
307
+
"Authorization": "Bearer YOUR_GITHUB_PAT"
308
+
}
309
+
}
310
+
}
311
+
}
312
+
}
313
+
```
314
+
315
+
## Using the {% data variables.product.github %} MCP server in Xcode
316
+
317
+
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in Xcode.
318
+
319
+
1. To open the chat view, click **Editor** in the menu bar, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}** then **Open Chat**. {% data variables.copilot.copilot_chat_short %} opens in a new window.
320
+
1. At the bottom of the chat panel, select **Agent**.
321
+
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon.
322
+
* Under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions.
323
+
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
324
+
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
325
+
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
326
+
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
327
+
1. Follow the prompts to complete the action.
328
+
329
+
{% endxcode %}
330
+
331
+
{% eclipse %}
332
+
333
+
{% data reusables.copilot.mcp.about-github-mcp-server %}
334
+
335
+
## Prerequisites
336
+
337
+
{% data reusables.copilot.eclipse-prerequisites %}
338
+
***Latest version of the {% data variables.product.prodname_copilot %} extension**. Download this from the [Eclipse Marketplace](https://aka.ms/copiloteclipse). For more information, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=eclipse).
339
+
***Sign in to {% data variables.product.company_short %} from Eclipse**.
340
+
341
+
## Setting up the {% data variables.product.github %} MCP server in Eclipse
342
+
343
+
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in Eclipse. Other MCP-compatible editors may have similar steps, but the exact process may vary.
344
+
345
+
We recommend setting up the {% data variables.product.github %} MCP server remotely. Eclipse only supports using a {% data variables.product.pat_generic %} (PAT) for authentication with the {% data variables.product.github %} MCP server.
346
+
347
+
> [!NOTE]
348
+
> If you are an {% data variables.product.prodname_emu %} with PAT restrictions, you won't be able to use PAT authentication.
349
+
350
+
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
351
+
352
+
### Remote MCP server configuration with PAT
353
+
354
+
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
355
+
356
+
1. To open the {% data variables.copilot.copilot_chat_short %} panel, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) in the status bar at the bottom of Eclipse.
357
+
1. From the menu, select "Edit preferences".
358
+
1. In the left pane, expand {% data variables.product.prodname_copilot %} and click **MCP**.
359
+
1. Add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created:
360
+
361
+
```json copy
362
+
{
363
+
"servers": {
364
+
"github": {
365
+
"url": "https://api.githubcopilot.com/mcp/",
366
+
"requestInit": {
367
+
"headers": {
368
+
"Authorization": "Bearer YOUR_GITHUB_PAT"
369
+
}
370
+
}
371
+
}
372
+
}
373
+
}
374
+
```
375
+
376
+
## Using the {% data variables.product.github %} MCP server in Eclipse
377
+
378
+
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in Eclipse.
379
+
380
+
1. To open the {% data variables.copilot.copilot_chat_short %} panel, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) in the status bar at the bottom of Eclipse, then click **Open Chat**.
381
+
1. At the bottom of the chat panel, select **Agent** from the mode dropdown.
382
+
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon.
383
+
* Under `github`, you will see a list of available actions.
384
+
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
385
+
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
386
+
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
387
+
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
388
+
1. Follow the prompts to complete the action.
389
+
390
+
{% endeclipse %}
391
+
197
392
{% data reusables.copilot.mcp.troubleshooting-mcp-server %}
Copy file name to clipboardExpand all lines: data/reusables/copilot/mcp/about-github-mcp-server.md
+1-6Lines changed: 1 addition & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -20,11 +20,6 @@ Running the {% data variables.product.github %} MCP server locally requires a bi
20
20
21
21
There is currently broad support for local MCP servers in clients such as {% data variables.product.prodname_vscode %}, JetBrains IDEs, XCode, and others.
22
22
23
-
Support for remote MCP servers is growing, with editors like {% data variables.product.prodname_vscode %} (with OAuth or PAT), {% data variables.product.prodname_vs %} (PAT only), Windsurf (PAT only), and Cursor (PAT only) already providing this functionality.
23
+
Support for remote MCP servers is growing, with editors like {% data variables.product.prodname_vscode %} (with OAuth or PAT), {% data variables.product.prodname_vs %} (PAT only), JetBrains IDEs (PAT only), Xcode (PAT only), Eclipse (PAT only), Windsurf (PAT only), and Cursor (PAT only) already providing this functionality.
24
24
25
25
To find out if your preferred editor supports remote MCP servers, check the documentation for your specific editor.
26
-
27
-
## Prerequisites
28
-
29
-
* A {% data variables.product.github %} account.
30
-
* {% data variables.product.prodname_vscode %}, or another MCP-compatible editor.
Looking for the latest TMZ celebrity news? You've come to the right place. From shocking Hollywood scandals to exclusive videos, TMZ delivers it all in real time.
Whether it’s a red carpet slip-up, a viral paparazzi moment, or a legal drama involving your favorite stars, TMZ news is always first to break the story. Stay in the loop with daily updates, insider tips, and jaw-dropping photos.
🎥 Watch TMZ Live
TMZ Live brings you daily celebrity news and interviews straight from the TMZ newsroom. Don’t miss a beat—watch now and see what’s trending in Hollywood.
0 commit comments