-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Insiders docs for OSS #1857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Insiders docs for OSS #1857
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds documentation for the Insiders Mode feature, which provides early access to new features and experimental tools for both local and remote GitHub MCP servers.
Changes:
- Documents insiders mode configuration for the remote server (via URL path
/insidersorX-MCP-Insidersheader) - Documents insiders mode configuration for the local server (via
--insider-modeflag orGITHUB_INSIDER_MODEenvironment variable) - Adds new URL path patterns for combining insiders mode with other modifiers
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds insiders mode documentation in both remote and local server sections with configuration examples |
| docs/remote-server.md | Adds comprehensive insiders mode documentation including headers, URL patterns, and combination examples |
| - `/x/all` - All available toolsets | ||
| - `/x/all/readonly` - All available toolsets in read-only mode | ||
| - `/x/all/insiders` - All available toolsets with insiders mode enabled | ||
| - `/x/{toolset}` - Single specific toolset | ||
| - `/x/{toolset}/readonly` - Single specific toolset in read-only mode | ||
| - `/x/{toolset}/insiders` - Single specific toolset with insiders mode enabled |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URL path patterns list includes /insiders/readonly (line 124) for combining both modifiers on the default toolset, but similar combinations are not shown for /x/all/ or /x/{toolset}/ patterns. For consistency and completeness, consider adding /x/all/insiders/readonly (or /x/all/readonly/insiders) and /x/{toolset}/insiders/readonly (or /x/{toolset}/readonly/insiders) to the list, or clarify in the note whether these combinations are supported via path or only via headers.
See below for a potential fix:
- `/x/all/insiders/readonly` - All available toolsets with insiders mode in read-only mode
- `/x/{toolset}` - Single specific toolset
- `/x/{toolset}/readonly` - Single specific toolset in read-only mode
- `/x/{toolset}/insiders` - Single specific toolset with insiders mode enabled
- `/x/{toolset}/insiders/readonly` - Single specific toolset with insiders mode in read-only mode
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 via path segments (for example, `/insiders/readonly`, `/x/all/insiders/readonly`, `/x/{toolset}/insiders/readonly`) or with the `X-MCP-Insiders` and `X-MCP-Readonly` headers.
Summary
Docs update for insiders mode
Why
Fixes https://github.com/github/copilot-mcp-core/issues/1148
What changed
MCP impact
Prompts tested (tool changes only)
Security / limits
Tool renaming
deprecated_tool_aliases.goNote: if you're renaming tools, you must add the tool aliases. For more information on how to do so, please refer to the official docs.
Lint & tests
./script/lint./script/testDocs