Skip to content

Commit 3e7579f

Browse files
committed
initial OSS insiders docs
1 parent 64752fd commit 3e7579f

File tree

2 files changed

+103
-1
lines changed

2 files changed

+103
-1
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,49 @@ See [Remote Server Documentation](docs/remote-server.md) for full details on rem
9898

9999
When no toolsets are specified, [default toolsets](#default-toolset) are used.
100100

101+
#### Insiders Mode
102+
103+
> **Try new features early!** The remote server offers an insiders version with early access to new features and experimental tools.
104+
105+
<table>
106+
<tr><th>Using URL Path</th><th>Using Header</th></tr>
107+
<tr valign=top>
108+
<td>
109+
110+
```json
111+
{
112+
"servers": {
113+
"github": {
114+
"type": "http",
115+
"url": "https://api.githubcopilot.com/mcp/insiders"
116+
}
117+
}
118+
}
119+
```
120+
121+
</td>
122+
<td>
123+
124+
```json
125+
{
126+
"servers": {
127+
"github": {
128+
"type": "http",
129+
"url": "https://api.githubcopilot.com/mcp/",
130+
"headers": {
131+
"X-MCP-Insiders": "true"
132+
}
133+
}
134+
}
135+
}
136+
```
137+
138+
</td>
139+
</tr>
140+
</table>
141+
142+
See [Remote Server Documentation](docs/remote-server.md#insiders-mode) for more details and examples.
143+
101144
#### GitHub Enterprise
102145

103146
##### GitHub Enterprise Cloud with data residency (ghe.com)
@@ -480,6 +523,31 @@ To keep the default configuration and add additional toolsets:
480523
GITHUB_TOOLSETS="default,stargazers" ./github-mcp-server
481524
```
482525

526+
### Insiders Mode
527+
528+
The local GitHub MCP Server offers an insiders version with early access to new features and experimental tools.
529+
530+
1. **Using Command Line Argument**:
531+
532+
```bash
533+
./github-mcp-server --insider-mode
534+
```
535+
536+
2. **Using Environment Variable**:
537+
538+
```bash
539+
GITHUB_INSIDER_MODE=true ./github-mcp-server
540+
```
541+
542+
When using Docker:
543+
544+
```bash
545+
docker run -i --rm \
546+
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
547+
-e GITHUB_INSIDER_MODE=true \
548+
ghcr.io/github/github-mcp-server
549+
```
550+
483551
### Available Toolsets
484552

485553
The following sets of tools are available:

docs/remote-server.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ The Remote GitHub MCP server has optional headers equivalent to the Local server
6767
- `X-MCP-Lockdown`: Enables lockdown mode, hiding public issue details created by users without push access.
6868
- Equivalent to `GITHUB_LOCKDOWN_MODE` env var for Local server.
6969
- If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.
70+
- `X-MCP-Insiders`: Enables insiders mode for early access to new features.
71+
- Equivalent to `GITHUB_INSIDER_MODE` env var or `--insider-mode` flag for Local server.
72+
- If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.
7073

7174
> **Looking for examples?** See the [Server Configuration Guide](./server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
7275
@@ -84,18 +87,49 @@ Example:
8487
}
8588
```
8689

90+
### Insiders Mode
91+
92+
The remote GitHub MCP Server offers an insiders version with early access to new features and experimental tools. You can enable insiders mode in two ways:
93+
94+
1. **Via URL path** - Append `/insiders` to the URL:
95+
96+
```json
97+
{
98+
"type": "http",
99+
"url": "https://api.githubcopilot.com/mcp/insiders"
100+
}
101+
```
102+
103+
2. **Via header** - Set the `X-MCP-Insiders` header to `true`:
104+
105+
```json
106+
{
107+
"type": "http",
108+
"url": "https://api.githubcopilot.com/mcp/",
109+
"headers": {
110+
"X-MCP-Insiders": "true"
111+
}
112+
}
113+
```
114+
115+
Both methods can be combined with other path modifiers (like `/readonly`) and headers.
116+
87117
### URL Path Parameters
88118

89119
The Remote GitHub MCP server supports the following URL path patterns:
90120

91121
- `/` - Default toolset (see ["default" toolset](../README.md#default-toolset))
92122
- `/readonly` - Default toolset in read-only mode
123+
- `/insiders` - Default toolset with insiders mode enabled
124+
- `/insiders/readonly` - Default toolset with insiders mode in read-only mode
93125
- `/x/all` - All available toolsets
94126
- `/x/all/readonly` - All available toolsets in read-only mode
127+
- `/x/all/insiders` - All available toolsets with insiders mode enabled
95128
- `/x/{toolset}` - Single specific toolset
96129
- `/x/{toolset}/readonly` - Single specific toolset in read-only mode
130+
- `/x/{toolset}/insiders` - Single specific toolset with insiders mode enabled
97131

98-
Note: `{toolset}` can only be a single toolset, not a comma-separated list. To combine multiple toolsets, use the `X-MCP-Toolsets` header instead.
132+
Note: `{toolset}` can only be a single toolset, not a comma-separated list. To combine multiple toolsets, use the `X-MCP-Toolsets` header instead. Path modifiers like `/readonly` and `/insiders` can be combined with the `X-MCP-Insiders` or `X-MCP-Readonly` headers.
99133

100134
Example:
101135

0 commit comments

Comments
 (0)