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
+58-18Lines changed: 58 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,7 +140,7 @@ When no toolsets are specified, [default toolsets](#default-toolset) are used.
140
140
</tr>
141
141
</table>
142
142
143
-
See [Remote Server Documentation](docs/remote-server.md#insiders-mode) for more details and examples.
143
+
See [Remote Server Documentation](docs/remote-server.md#insiders-mode) for more details and examples, and [Insiders Features](docs/insiders-features.md) for a full list of what's available.
144
144
145
145
#### GitHub Enterprise
146
146
@@ -153,7 +153,7 @@ Example for `https://octocorp.ghe.com` with GitHub PAT token:
@@ -560,6 +560,7 @@ The following sets of tools are available:
560
560
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/person-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/person-light.png"><imgsrc="pkg/octicons/icons/person-light.png"width="20"height="20"alt="person"></picture> |`context`|**Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in |
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/codescan-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/codescan-light.png"><imgsrc="pkg/octicons/icons/codescan-light.png"width="20"height="20"alt="codescan"></picture> |`code_security`| Code security related tools, such as GitHub Code Scanning |
563
+
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/copilot-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/copilot-light.png"><imgsrc="pkg/octicons/icons/copilot-light.png"width="20"height="20"alt="copilot"></picture> |`copilot`| Copilot related tools |
-**assign_copilot_to_issue** - Assign Copilot to issue
693
+
-**Required OAuth Scopes**: `repo`
694
+
-`base_ref`: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional)
695
+
-`custom_instructions`: Optional custom instructions to guide the agent beyond the issue body. Use this to provide additional context, constraints, or guidance that is not captured in the issue description (string, optional)
@@ -794,14 +815,6 @@ The following sets of tools are available:
794
815
-`owner`: Repository owner (string, required)
795
816
-`repo`: Repository name (string, required)
796
817
797
-
-**assign_copilot_to_issue** - Assign Copilot to issue
798
-
-**Required OAuth Scopes**: `repo`
799
-
-`base_ref`: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional)
800
-
-`custom_instructions`: Optional custom instructions to guide the agent beyond the issue body. Use this to provide additional context, constraints, or guidance that is not captured in the issue description (string, optional)
801
-
-`issue_number`: Issue number (number, required)
802
-
-`owner`: Repository owner (string, required)
803
-
-`repo`: Repository name (string, required)
804
-
805
818
-**get_label** - Get a specific label from a repository.
806
819
-**Required OAuth Scopes**: `repo`
807
820
-`name`: Label name. (string, required)
@@ -1084,11 +1097,12 @@ The following sets of tools are available:
1084
1097
Possible options:
1085
1098
1. get - Get details of a specific pull request.
1086
1099
2. get_diff - Get the diff of a pull request.
1087
-
3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.
1100
+
3. get_status - Get combined commit status of a head commit in a pull request.
1088
1101
4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.
1089
1102
5. get_review_comments - Get review threads on a pull request. Each thread contains logically grouped review comments made on the same code location during pull request reviews. Returns threads with metadata (isResolved, isOutdated, isCollapsed) and their associated comments. Use cursor-based pagination (perPage, after) to control results.
1090
1103
6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.
1091
1104
7. get_comments - Get comments on a pull request. Use this if user doesn't specifically want review comments. Use with pagination parameters to control the number of results returned.
1105
+
8. get_check_runs - Get check runs for the head commit of a pull request. Check runs are the individual CI/CD jobs and checks that run on the PR.
1092
1106
(string, required)
1093
1107
-`owner`: Repository owner (string, required)
1094
1108
-`page`: Page number for pagination (min 1) (number, optional)
@@ -1105,12 +1119,7 @@ The following sets of tools are available:
1105
1119
-`owner`: Repository owner (string, required)
1106
1120
-`pullNumber`: Pull request number (number, required)
-`pullNumber`: Pull request number (number, required)
1113
-
-`repo`: Repository name (string, required)
1122
+
-`threadId`: The node ID of the review thread (e.g., PRRT_kwDOxxx). Required for resolve_thread and unresolve_thread methods. Get thread IDs from pull_request_read with method get_review_comments. (string, optional)
1114
1123
1115
1124
-**search_pull_requests** - Search pull requests
1116
1125
-**Required OAuth Scopes**: `repo`
@@ -1163,7 +1172,7 @@ The following sets of tools are available:
1163
1172
-`owner`: Repository owner (username or organization) (string, required)
1164
1173
-`path`: Path where to create/update the file (string, required)
1165
1174
-`repo`: Repository name (string, required)
1166
-
-`sha`: The blob SHA of the file being replaced. (string, optional)
1175
+
-`sha`: The blob SHA of the file being replaced. Required if the file already exists. (string, optional)
1167
1176
1168
1177
-**create_repository** - Create repository
1169
1178
-**Required OAuth Scopes**: `repo`
@@ -1233,9 +1242,12 @@ The following sets of tools are available:
1233
1242
-`author`: Author username or email address to filter commits by (string, optional)
1234
1243
-`owner`: Repository owner (string, required)
1235
1244
-`page`: Page number for pagination (min 1) (number, optional)
1245
+
-`path`: Only commits containing this file path will be returned (string, optional)
1236
1246
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1237
1247
-`repo`: Repository name (string, required)
1238
1248
-`sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional)
1249
+
-`since`: Only commits after this date will be returned (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD) (string, optional)
1250
+
-`until`: Only commits before this date will be returned (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD) (string, optional)
1239
1251
1240
1252
-**list_releases** - List releases
1241
1253
-**Required OAuth Scopes**: `repo`
@@ -1528,6 +1540,34 @@ set the following environment variable:
1528
1540
export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description"
1529
1541
```
1530
1542
1543
+
### Overriding Server Name and Title
1544
+
1545
+
The same override mechanism can be used to customize the MCP server's `name` and
1546
+
`title` fields in the initialization response. This is useful when running
1547
+
multiple GitHub MCP Server instances (e.g., one for github.com and one for
1548
+
GitHub Enterprise Server) so that agents can distinguish between them.
For example, to configure a server instance for GitHub Enterprise Server:
1556
+
1557
+
```json
1558
+
{
1559
+
"SERVER_NAME": "ghes-mcp-server",
1560
+
"SERVER_TITLE": "GHES MCP Server"
1561
+
}
1562
+
```
1563
+
1564
+
Or using environment variables:
1565
+
1566
+
```sh
1567
+
export GITHUB_MCP_SERVER_NAME="ghes-mcp-server"
1568
+
export GITHUB_MCP_SERVER_TITLE="GHES MCP Server"
1569
+
```
1570
+
1531
1571
## Library Usage
1532
1572
1533
1573
The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.
Insiders Mode gives you access to experimental features in the GitHub MCP Server. These features may change, evolve, or be removed based on community feedback.
4
+
5
+
We created this mode to have a way to roll out experimental features and collect feedback. So if you are using Insiders, please don't hesitate to share your feedback with us!
6
+
7
+
> [!NOTE]
8
+
> Features in Insiders Mode are experimental.
9
+
10
+
## Enabling Insiders Mode
11
+
12
+
| Method | Remote Server | Local Server |
13
+
|--------|---------------|--------------|
14
+
| URL path | Append `/insiders` to the URL | N/A |
For configuration examples, see the [Server Configuration Guide](./server-configuration.md#insiders-mode).
20
+
21
+
---
22
+
23
+
## MCP Apps
24
+
25
+
[MCP Apps](https://modelcontextprotocol.io/docs/extensions/apps) is an extension to the Model Context Protocol that enables servers to deliver interactive user interfaces to end users. Instead of returning plain text that the LLM must interpret and relay, tools can render forms, profiles, and dashboards right in the chat using MCP Apps.
26
+
27
+
This means you can interact with GitHub visually: fill out forms to create issues, see user profiles with avatars, open pull requests — all without leaving your agent chat.
28
+
29
+
### Supported tools
30
+
31
+
The following tools have MCP Apps UIs:
32
+
33
+
| Tool | Description |
34
+
|------|-------------|
35
+
|`get_me`| Displays your GitHub user profile with avatar, bio, and stats in a rich card |
36
+
|`issue_write`| Opens an interactive form to create or update issues |
37
+
|`create_pull_request`| Provides a full PR creation form to create a pull request (or a draft pull request) |
38
+
39
+
### Client requirements
40
+
41
+
MCP Apps requires a host that supports the [MCP Apps extension](https://modelcontextprotocol.io/docs/extensions/apps). Currently tested and working with:
42
+
43
+
-**VS Code Insiders** — enable via the `chat.mcp.apps.enabled` setting
44
+
-**Visual Studio Code** — enable via the `chat.mcp.apps.enabled` setting
0 commit comments