Skip to content

[docs] docs: tighten MCP gateway guard-policy prose#44365

Merged
pelikhan merged 1 commit into
mainfrom
docs/unbloat-mcp-gateway-3f26e547c4c6b096
Jul 8, 2026
Merged

[docs] docs: tighten MCP gateway guard-policy prose#44365
pelikhan merged 1 commit into
mainfrom
docs/unbloat-mcp-gateway-3f26e547c4c6b096

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Tightens the prose in docs/src/content/docs/reference/mcp-gateway.md, sections 10.5–10.9, with no semantic or behavioral changes. Verbose bullet-list and numbered-step blocks are collapsed into compact inline sentences while preserving all normative content.

Changes

Section Before After
§10.5 approval-labels 5-bullet Semantics sub-section Single prose sentence
§10.6 refusal-labels 5-bullet Semantics sub-section Single prose sentence
§10.6 config example 2-bullet explanation block Inline sentence
§10.6 Requirements Parenthetical (no items are downgraded) Removed parenthetical
§10.8.3 accept interaction 2-bullet list for public / private cases Prose paragraph
§10.8.6 Default Sink Visibility 4-item numbered rules list Single prose sentence
§10.8.7 Safe-Outputs Safety Net 4-bullet trigger conditions Single prose sentence
§10.9 private-to-public-flows 2-bullet form descriptions Inline prose
§10.9.2 Constraints 4-bullet list Single prose paragraph
§10.9.3 Compiler Responsibilities Two numbered sub-sections (8 steps total) One prose sentence per form
§10.9.5 Security Rationale 3-bullet use-case list Inline prose sentence

Files changed

  • docs/src/content/docs/reference/mcp-gateway.md — prose-only edits (~66 lines removed, ~18 added)

Impact

  • No API, runtime, or behavioral changes.
  • No test changes required.
  • Normative MUST requirements are fully preserved in the rewritten prose.

Generated by PR Description Updater for #44365 · 43.4 AIC · ⌖ 8.87 AIC · ⊞ 4.7K ·

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

Hey @github-actions — nice work compressing the MCP gateway guard-policy and cross-visibility sections in docs/src/content/docs/reference/mcp-gateway.md! Removing repetitive bullet prose while preserving all examples, tables, and compliance references is exactly the kind of targeted doc-unbloat this workflow aims for.

One small note:

  • No test changes present — for a documentation-only PR this is completely expected and not a real concern. There are no doc-test or prose-validation steps to add here.

The PR is currently in draft state. Once the content has been reviewed for accuracy (especially the condensed private-to-public-flows security rationale), it should be ready to mark as ready for review.

If you would like a final accuracy pass on the condensed sections, you can assign this prompt to your coding agent:

Review the condensed sections in docs/src/content/docs/reference/mcp-gateway.md introduced by PR #44365.
Specifically verify:
1. The approval-labels and refusal-labels condensed semantics still accurately reflect the full original intent.
2. The sink-visibility prose consolidation hasn't dropped any edge-case behavior.
3. The private-to-public-flows security rationale still covers all original compliance requirements.
Report any information that was lost or subtly altered in the compression.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • patchdiff.githubusercontent.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "patchdiff.githubusercontent.com"

See Network Configuration for more information.

Generated by ✅ Contribution Check · 296.9 AIC · ⌖ 13.7 AIC · ⊞ 6.2K ·

@pelikhan pelikhan marked this pull request as ready for review July 8, 2026 20:22
Copilot AI review requested due to automatic review settings July 8, 2026 20:22
@pelikhan pelikhan merged commit bd5467f into main Jul 8, 2026
@pelikhan pelikhan deleted the docs/unbloat-mcp-gateway-3f26e547c4c6b096 branch July 8, 2026 20:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 tightens and de-bloats the MCP gateway reference documentation by consolidating repetitive guard-policy and cross-visibility explanations into concise prose while keeping the existing requirements, examples, and compliance references intact.

Changes:

  • Condensed approval-labels / refusal-labels semantics into single-paragraph descriptions.
  • Merged several bullet-heavy sections around sink-visibility and accept interaction into clearer prose.
  • Simplified the private-to-public-flows opt-out explanation (constraints + compiler responsibilities) without changing the stated behavior.
Show a summary per file
File Description
docs/src/content/docs/reference/mcp-gateway.md Reduces repetitive wording across guard-policy and cross-visibility sections while preserving requirements, examples, and compliance references.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Low

2. If the server ID appears in `gateway.sinkVisibilityExemptServers` → the default is NOT applied.
3. If `sinkVisibilityExemptServers` contains `"*"` → no server receives the default.
4. If `forcePublicRepos` is `false` → all servers are implicitly exempt (blanket opt-out).
The default applies only when the server is not `safe-outputs` (or legacy `safeoutputs`), the server is not listed in `gateway.sinkVisibilityExemptServers`, that exemption list does not contain `"*"`, and `forcePublicRepos` is not `false`.
@github-actions github-actions Bot mentioned this pull request Jul 9, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.82.7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation doc-unbloat documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants