Skip to content

chore: restructure README around quickstart and guard policies#1979

Merged
lpcox merged 1 commit intomainfrom
chore/cleanup-stale-docs
Mar 15, 2026
Merged

chore: restructure README around quickstart and guard policies#1979
lpcox merged 1 commit intomainfrom
chore/cleanup-stale-docs

Conversation

@lpcox
Copy link
Collaborator

@lpcox lpcox commented Mar 15, 2026

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.

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>
Copilot AI review requested due to automatic review settings March 15, 2026 19:00
@lpcox lpcox merged commit f1e4479 into main Mar 15, 2026
3 checks passed
@lpcox lpcox deleted the chore/cleanup-stale-docs branch March 15, 2026 19:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md around Quick Start, Guard Policies, Architecture, API Endpoints, and Further Reading links.
  • Expanded docs/CONFIGURATION.md with 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-policies alone doesn’t select a non-noop guard for allow-only; users need to configure a guard (e.g., "guard": "github-guard" plus a guards entry) or rely on discovered per-server WASM guards. Consider adding a minimal guard/guards snippet 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants