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
+70-68Lines changed: 70 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,6 +98,27 @@ The default configuration is:
98
98
99
99
See [Remote Server Documentation](docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
100
100
101
+
#### Enterprise Cloud with data residency (ghe.com)
102
+
103
+
GitHub Enterprise Cloud can also make use of the remote server.
GitHub Enterprise Server does not support remote server hosting. Please refer to [GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)](#github-enterprise-server-and-enterprise-cloud-with-data-residency-ghecom) from the local server configuration.
121
+
101
122
---
102
123
103
124
## Local GitHub MCP Server
@@ -160,6 +181,33 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
160
181
161
182
</details>
162
183
184
+
### GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
185
+
186
+
The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
187
+
the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
188
+
189
+
- For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
190
+
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
207
+
}
208
+
}
209
+
```
210
+
163
211
## Installation
164
212
165
213
### Install in GitHub Copilot on VS Code
@@ -668,15 +716,6 @@ The following sets of tools are available (all are on by default):
668
716
-`title`: New title (string, optional)
669
717
-`type`: New issue type (string, optional)
670
718
671
-
-**write_label** - Write operations on repository labels.
672
-
-`color`: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). Required for 'create', optional for 'update'. (string, optional)
673
-
-`description`: Label description text. Optional for 'create' and 'update'. (string, optional)
674
-
-`method`: Operation to perform: 'create', 'update', or 'delete' (string, required)
675
-
-`name`: Label name - required for all operations (string, required)
676
-
-`new_name`: New name for the label (used only with 'update' method to rename) (string, optional)
677
-
-`owner`: Repository owner (username or organization name) (string, required)
678
-
-`repo`: Repository name (string, required)
679
-
680
719
</details>
681
720
682
721
<details>
@@ -688,12 +727,7 @@ The following sets of tools are available (all are on by default):
688
727
-`owner`: Repository owner (username or organization name) (string, required)
689
728
-`repo`: Repository name (string, required)
690
729
691
-
-**list_label** - List labels from a repository or an issue
692
-
-`issue_number`: Issue number - if provided, lists labels on the specific issue (number, optional)
693
-
-`owner`: Repository owner (username or organization name) - required for all operations (string, required)
694
-
-`repo`: Repository name - required for all operations (string, required)
695
-
696
-
-**write_label** - Write operations on repository labels.
730
+
-**label_write** - Write operations on repository labels.
697
731
-`color`: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). Required for 'create', optional for 'update'. (string, optional)
698
732
-`description`: Label description text. Optional for 'create' and 'update'. (string, optional)
699
733
-`method`: Operation to perform: 'create', 'update', or 'delete' (string, required)
@@ -702,6 +736,11 @@ The following sets of tools are available (all are on by default):
702
736
-`owner`: Repository owner (username or organization name) (string, required)
703
737
-`repo`: Repository name (string, required)
704
738
739
+
-**list_label** - List labels from a repository or an issue
740
+
-`issue_number`: Issue number - if provided, lists labels on the specific issue (number, optional)
741
+
-`owner`: Repository owner (username or organization name) - required for all operations (string, required)
742
+
-`repo`: Repository name - required for all operations (string, required)
743
+
705
744
</details>
706
745
707
746
<details>
@@ -806,6 +845,13 @@ The following sets of tools are available (all are on by default):
806
845
-`per_page`: Number of results per page (max 100, default: 30) (number, optional)
807
846
-`query`: Filter projects by a search query (matches title and description) (string, optional)
808
847
848
+
-**update_project_item** - Update project item
849
+
-`item_id`: The unique identifier of the project item. This is not the issue or pull request ID. (number, required)
850
+
-`owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
851
+
-`owner_type`: Owner type (string, required)
852
+
-`project_number`: The project's number. (number, required)
853
+
-`updated_field`: Object consisting of the ID of the project field to update and the new value for the field. To clear the field, set "value" to null. Example: {"id": 123456, "value": "New Value"} (object, required)
854
+
809
855
</details>
810
856
811
857
<details>
@@ -824,20 +870,6 @@ The following sets of tools are available (all are on by default):
824
870
-`startSide`: For multi-line comments, the starting side of the diff that the comment applies to. LEFT indicates the previous state, RIGHT indicates the new state (string, optional)
825
871
-`subjectType`: The level at which the comment is targeted (string, required)
826
872
827
-
-**create_and_submit_pull_request_review** - Create and submit a pull request review without comments
828
-
-`body`: Review comment text (string, required)
829
-
-`commitID`: SHA of commit to review (string, optional)
830
-
-`event`: Review action to perform (string, required)
831
-
-`owner`: Repository owner (string, required)
832
-
-`pullNumber`: Pull request number (number, required)
-`pullNumber`: Pull request number (number, required)
@@ -902,13 +938,6 @@ Possible options:
902
938
-`repo`: Optional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional)
903
939
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
904
940
905
-
-**submit_pending_pull_request_review** - Submit the requester's latest pending pull request review
906
-
-`body`: The text of the review comment (string, optional)
907
-
-`event`: The event to perform (string, required)
908
-
-`owner`: Repository owner (string, required)
909
-
-`pullNumber`: Pull request number (number, required)
910
-
-`repo`: Repository name (string, required)
911
-
912
941
-**update_pull_request** - Edit pull request
913
942
-`base`: New base branch name (string, optional)
914
943
-`body`: New description (string, optional)
@@ -1200,33 +1229,6 @@ docker run -i --rm \
1200
1229
ghcr.io/github/github-mcp-server
1201
1230
```
1202
1231
1203
-
## GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
1204
-
1205
-
The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
1206
-
the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
1207
-
1208
-
- For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
1209
-
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
0 commit comments