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
@@ -26,27 +26,100 @@ The remote GitHub MCP Server is hosted by GitHub and provides the easiest method
26
26
27
27
### Usage with VS Code
28
28
29
-
For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start.
29
+
For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start. Make sure you're using [VS Code 1.101](https://code.visualstudio.com/updates/v1_101) or [later](https://code.visualstudio.com/updates) for remote MCP and OAuth support.
30
30
31
-
### Usage in other MCP Hosts
32
31
33
-
For MCP Hosts that have been [configured to use the remote GitHub MCP Server](docs/host-integration.md), add the following JSON block to the host's configuration:
32
+
Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration:
34
33
34
+
<table>
35
+
<tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr>
36
+
<tr><thalign=leftcolspan=2>VS Code (version 1.101 or greater)</th></tr>
37
+
<trvalign=top>
38
+
<td>
39
+
35
40
```json
36
41
{
37
-
"mcp": {
38
-
"servers": {
39
-
"github": {
40
-
"type": "http",
41
-
"url": "https://api.githubcopilot.com/mcp/"
42
+
"servers": {
43
+
"github": {
44
+
"type": "http",
45
+
"url": "https://api.githubcopilot.com/mcp/"
46
+
}
47
+
}
48
+
}
49
+
```
50
+
51
+
</td>
52
+
<td>
53
+
54
+
```json
55
+
{
56
+
"servers": {
57
+
"github": {
58
+
"type": "http",
59
+
"url": "https://api.githubcopilot.com/mcp/",
60
+
"headers": {
61
+
"Authorization": "Bearer ${input:github_mcp_pat}"
42
62
}
43
63
}
64
+
},
65
+
"inputs": [
66
+
{
67
+
"type": "promptString",
68
+
"id": "github_mcp_pat",
69
+
"description": "GitHub Personal Access Token",
70
+
"password": true
71
+
}
72
+
]
73
+
}
74
+
```
75
+
76
+
</td>
77
+
</tr>
78
+
</table>
79
+
80
+
### Usage in other MCP Hosts
81
+
82
+
For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose the appropriate JSON block from the examples below and add it to your host configuration:
83
+
84
+
<table>
85
+
<tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr>
86
+
<trvalign=top>
87
+
<td>
88
+
89
+
```json
90
+
{
91
+
"mcpServers": {
92
+
"github": {
93
+
"url": "https://api.githubcopilot.com/mcp/"
94
+
}
95
+
}
96
+
}
97
+
```
98
+
99
+
</td>
100
+
<td>
101
+
102
+
```json
103
+
{
104
+
"mcpServers": {
105
+
"github": {
106
+
"url": "https://api.githubcopilot.com/mcp/",
107
+
"authorization_token": "Bearer <your GitHub PAT>"
108
+
}
44
109
}
45
110
}
46
111
```
47
112
113
+
</td>
114
+
</tr>
115
+
</table>
116
+
48
117
> **Note:** The exact configuration format may vary by host. Refer to your host's documentation for the correct syntax and location for remote MCP server setup.
49
118
119
+
### Configuration
120
+
121
+
See [Remote Server Documentation](docs/remote-server.md) on how to pass additional configuration settings to the remote GitHub MCP Server.
122
+
50
123
---
51
124
52
125
## Local GitHub MCP Server
@@ -192,6 +265,7 @@ The following sets of tools are available (all are on by default):
@@ -439,6 +513,14 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
439
513
-`page`: Page number (number, optional)
440
514
-`perPage`: Results per page (number, optional)
441
515
516
+
-**assign_copilot_to_issue** - Assign Copilot to a specific issue in a GitHub repository
517
+
518
+
-`owner`: Repository owner (string, required)
519
+
-`repo`: Repository name (string, required)
520
+
-`issueNumber`: Issue number (number, required)
521
+
-_Note_: This tool can help with creating a Pull Request with source code changes to resolve the issue. More information can be found at [GitHub Copilot documentation](https://docs.github.com/en/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot)
522
+
523
+
442
524
### Pull Requests
443
525
444
526
-**get_pull_request** - Get details of a specific pull request
@@ -497,6 +579,12 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
497
579
-`repo`: Repository name (string, required)
498
580
-`pullNumber`: Pull request number (number, required)
499
581
582
+
-**get_pull_request_diff** - Get the diff of a pull request
583
+
584
+
-`owner`: Repository owner (string, required)
585
+
-`repo`: Repository name (string, required)
586
+
-`pullNumber`: Pull request number (number, required)
587
+
500
588
-**create_pull_request_review** - Create a review on a pull request review
501
589
502
590
-`owner`: Repository owner (string, required)
@@ -509,6 +597,53 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
509
597
- For inline comments: provide `path`, `position` (or `line`), and `body`
510
598
- For multi-line comments: provide `path`, `start_line`, `line`, optional `side`/`start_side`, and `body`
511
599
600
+
-**create_pending_pull_request_review** - Create a pending review for a pull request that can be submitted later
601
+
602
+
-`owner`: Repository owner (string, required)
603
+
-`repo`: Repository name (string, required)
604
+
-`pullNumber`: Pull request number (number, required)
605
+
-`commitID`: SHA of commit to review (string, optional)
606
+
607
+
-**add_pull_request_review_comment_to_pending_review** - Add a comment to the requester's latest pending pull request review
608
+
609
+
-`owner`: Repository owner (string, required)
610
+
-`repo`: Repository name (string, required)
611
+
-`pullNumber`: Pull request number (number, required)
612
+
-`path`: The relative path to the file that necessitates a comment (string, required)
613
+
-`body`: The text of the review comment (string, required)
614
+
-`subjectType`: The level at which the comment is targeted (string, required)
615
+
- Enum: "FILE", "LINE"
616
+
-`line`: The line of the blob in the pull request diff that the comment applies to (number, optional)
617
+
-`side`: The side of the diff to comment on (string, optional)
618
+
- Enum: "LEFT", "RIGHT"
619
+
-`startLine`: For multi-line comments, the first line of the range (number, optional)
620
+
-`startSide`: For multi-line comments, the starting side of the diff (string, optional)
621
+
- Enum: "LEFT", "RIGHT"
622
+
623
+
-**submit_pending_pull_request_review** - Submit the requester's latest pending pull request review
624
+
625
+
-`owner`: Repository owner (string, required)
626
+
-`repo`: Repository name (string, required)
627
+
-`pullNumber`: Pull request number (number, required)
628
+
-`event`: The event to perform (string, required)
629
+
- Enum: "APPROVE", "REQUEST_CHANGES", "COMMENT"
630
+
-`body`: The text of the review comment (string, optional)
631
+
632
+
-**delete_pending_pull_request_review** - Delete the requester's latest pending pull request review
633
+
634
+
-`owner`: Repository owner (string, required)
635
+
-`repo`: Repository name (string, required)
636
+
-`pullNumber`: Pull request number (number, required)
637
+
638
+
-**create_and_submit_pull_request_review** - Create and submit a review for a pull request without review comments
639
+
640
+
-`owner`: Repository owner (string, required)
641
+
-`repo`: Repository name (string, required)
642
+
-`pullNumber`: Pull request number (number, required)
0 commit comments