Skip to content

Commit c95cb0d

Browse files
Merge branch 'main' into mcp-apps-pre-ui-submission-insistent
2 parents dec1000 + 1fec99f commit c95cb0d

File tree

3 files changed

+103
-1
lines changed

3 files changed

+103
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ When no toolsets are specified, [default toolsets](#default-toolset) are used.
140140
</tr>
141141
</table>
142142

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.
144144

145145
#### GitHub Enterprise
146146

docs/insiders-features.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Insiders Features
2+
3+
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 |
15+
| Header | `X-MCP-Insiders: true` | N/A |
16+
| CLI flag | N/A | `--insiders` |
17+
| Environment variable | N/A | `GITHUB_INSIDERS=true` |
18+
19+
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

docs/server-configuration.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ We currently support the following ways in which the GitHub MCP Server can be co
1313
| Read-Only Mode | `X-MCP-Readonly` header or `/readonly` URL | `--read-only` flag or `GITHUB_READ_ONLY` env var |
1414
| Dynamic Mode | Not available | `--dynamic-toolsets` flag or `GITHUB_DYNAMIC_TOOLSETS` env var |
1515
| Lockdown Mode | `X-MCP-Lockdown` header | `--lockdown-mode` flag or `GITHUB_LOCKDOWN_MODE` env var |
16+
| Insiders Mode | `X-MCP-Insiders` header or `/insiders` URL | `--insiders` flag or `GITHUB_INSIDERS` env var |
1617
| Scope Filtering | Always enabled | Always enabled |
1718

1819
> **Default behavior:** If you don't specify any configuration, the server uses the **default toolsets**: `context`, `issues`, `pull_requests`, `repos`, `users`.
@@ -384,6 +385,63 @@ Lockdown mode ensures the server only surfaces content in public repositories fr
384385

385386
---
386387

388+
### Insiders Mode
389+
390+
**Best for:** Users who want early access to experimental features and new tools before they reach general availability.
391+
392+
Insiders Mode unlocks experimental features, such as [MCP Apps](./insiders-features.md#mcp-apps) support. 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! Features in Insiders Mode may change, evolve, or be removed based on user feedback.
393+
394+
<table>
395+
<tr><th>Remote Server</th><th>Local Server</th></tr>
396+
<tr valign="top">
397+
<td>
398+
399+
**Option A: URL path**
400+
```json
401+
{
402+
"type": "http",
403+
"url": "https://api.githubcopilot.com/mcp/insiders"
404+
}
405+
```
406+
407+
**Option B: Header**
408+
```json
409+
{
410+
"type": "http",
411+
"url": "https://api.githubcopilot.com/mcp/",
412+
"headers": {
413+
"X-MCP-Insiders": "true"
414+
}
415+
}
416+
```
417+
418+
</td>
419+
<td>
420+
421+
```json
422+
{
423+
"type": "stdio",
424+
"command": "go",
425+
"args": [
426+
"run",
427+
"./cmd/github-mcp-server",
428+
"stdio",
429+
"--insiders"
430+
],
431+
"env": {
432+
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
433+
}
434+
}
435+
```
436+
437+
</td>
438+
</tr>
439+
</table>
440+
441+
See [Insiders Features](./insiders-features.md) for a full list of what's available in Insiders Mode.
442+
443+
---
444+
387445
### Scope Filtering
388446

389447
**Automatic feature:** The server handles OAuth scopes differently depending on authentication type:

0 commit comments

Comments
 (0)