chore: restructure README around quickstart and guard policies#1979
Merged
chore: restructure README around quickstart and guard policies#1979
Conversation
Reorganize README from 333 to 165 lines with focused structure: - Quick Start (Docker) stays prominent at top - Guard Policies section with allow-only and write-sink examples - Architecture diagram with transport/routing/security/logging summary - API Endpoints (brief) - Further Reading table linking to all detailed docs Move TOML config format, JSON examples, usage CLI flags, env vars, containerized mode, logging details, auth, and compatibility info into docs/ sub-documents or the Further Reading links. Add TOML format section and usage examples to docs/CONFIGURATION.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Restructures the top-level README into a shorter, quickstart-first document and moves detailed configuration/usage material into the docs, adding a new “Configuration Formats” section and examples to the configuration reference.
Changes:
- Reorganized
README.mdaround Quick Start, Guard Policies, Architecture, API Endpoints, and Further Reading links. - Expanded
docs/CONFIGURATION.mdwith JSON-vs-TOML format guidance, examples, validation notes, and CLI usage. - Consolidated references to detailed topics (env vars, sessions, security model, etc.) via a “Further Reading” table in the README.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/CONFIGURATION.md | Adds configuration-format overview, TOML/JSON examples, validation notes, and CLI usage guidance. |
| README.md | Replaces long-form documentation with a structured quickstart + guard policies + links to detailed docs. |
Comments suppressed due to low confidence (1)
docs/CONFIGURATION.md:69
- This JSON example also omits how the guard itself is enabled.
guard-policiesalone doesn’t select a non-noop guard for allow-only; users need to configure a guard (e.g.,"guard": "github-guard"plus aguardsentry) or rely on discovered per-server WASM guards. Consider adding a minimalguard/guardssnippet or a short note here to prevent configs that appear valid but don’t actually enforce DIFC.
"mcpServers": {
"github": {
"type": "stdio",
"container": "ghcr.io/github/github-mcp-server:latest",
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": ""
},
"guard-policies": {
"allow-only": {
"repos": ["github/gh-aw-mcpg", "github/gh-aw"],
"min-integrity": "unapproved"
}
}
},
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+22
to
+29
| [servers.github] | ||
| command = "docker" | ||
| args = ["run", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "-i", "ghcr.io/github/github-mcp-server:latest"] | ||
|
|
||
| [servers.github.guard_policies.allow-only] | ||
| repos = ["github/gh-aw-mcpg", "github/gh-aw"] | ||
| min-integrity = "unapproved" | ||
|
|
Comment on lines
+59
to
+70
| ```json | ||
| "github": { | ||
| "type": "stdio", | ||
| "container": "ghcr.io/github/github-mcp-server:latest", | ||
| "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "" }, | ||
| "guard-policies": { | ||
| "allow-only": { | ||
| "repos": ["github/gh-aw-mcpg", "github/gh-aw"], | ||
| "min-integrity": "unapproved" | ||
| } | ||
| } | ||
| } |
|
|
||
| ### Configuration Validation | ||
|
|
||
| The gateway provides fail-fast validation with precise error locations (line/column for TOML parse errors), unknown key detection (catches typos like `prot` instead of `port`), and environment variable expansion validation. Check log files for warnings after startup. |
This was referenced Mar 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganize README from 333 to 165 lines with focused structure:
Move TOML config format, JSON examples, usage CLI flags, env vars, containerized mode, logging details, auth, and compatibility info into docs/ sub-documents or the Further Reading links.
Add TOML format section and usage examples to docs/CONFIGURATION.md.