Skip to content

[docs] docs: unbloat getting-started-mcp guide#20136

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-getting-started-mcp-913abbc7a37e0f24
Mar 9, 2026
Merged

[docs] docs: unbloat getting-started-mcp guide#20136
pelikhan merged 1 commit intomainfrom
docs/unbloat-getting-started-mcp-913abbc7a37e0f24

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Mar 9, 2026

Removes ~70 lines of duplicate and verbose content from docs/src/content/docs/guides/getting-started-mcp.md (324 → 255 lines, 21% reduction).

Changes made

Type of bloat Lines removed
Redundant "Common toolset combinations" table (duplicated by Available Toolsets table below it) ~9
Operating Modes section condensed from two full YAML examples to a 2-sentence summary + reference link ~19
Read-Only Mode section removed (a fixed constraint, not a user-configurable option) ~12
Example 2 "PR Review with Actions Data" removed (near-identical pattern to Example 1) ~22
"Registry-based Configuration" subsection merged into "Adding Servers" ~5
Next Steps intro sentence and trailing paragraph trimmed ~3

All essential information is preserved — the Operating Modes section now links to the full reference in github-tools, and the remaining two practical examples still demonstrate different use cases (issue triage vs. multi-service security audit).

Screenshots

Screenshots could not be captured: the Playwright browser runs in a network-sandboxed container that cannot reach the local preview server (connection timed out on both localhost:4321 and the host network interface). The documentation build succeeds normally and the page structure/links are intact.

References:

🗜️ Compressed by Documentation Unbloat ·

  • expires on Mar 11, 2026, 12:07 AM UTC

Remove ~70 lines of duplicate and verbose content:
- Drop redundant "Common toolset combinations" table (covered by Available Toolsets below)
- Condense Operating Modes from two full YAML examples to a two-sentence summary with a reference link
- Remove Read-Only Mode section (a constraint, not an actionable configuration)
- Remove Example 2 (PR Review), which was nearly identical to Example 1
- Merge "Registry-based Configuration" subsection into "Adding Servers"
- Simplify Next Steps intro and trailing paragraph

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 9, 2026
@pelikhan pelikhan marked this pull request as ready for review March 9, 2026 00:12
Copilot AI review requested due to automatic review settings March 9, 2026 00:12
@pelikhan
Copy link
Contributor

pelikhan commented Mar 9, 2026

/q configure firewall to allow localhost

@pelikhan pelikhan merged commit ed838f0 into main Mar 9, 2026
2 checks passed
@pelikhan pelikhan deleted the docs/unbloat-getting-started-mcp-913abbc7a37e0f24 branch March 9, 2026 00:14
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

Reduces duplication and verbosity in the “Getting Started with MCP” guide while preserving essential guidance via tighter wording and reference links.

Changes:

  • Removed redundant toolset and workflow examples to reduce repeated content.
  • Condensed Operating Modes and Read-Only guidance into brief summaries with links to the full reference docs.
  • Simplified “Next Steps” and merged/removed minor sub-sections for a shorter, more scannable guide.

💡 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.

```

Write operations are handled through [safe outputs](/gh-aw/reference/safe-outputs/), which execute in a separate, permission-controlled job after the agent completes.
The GitHub MCP server always operates read-only. Write operations are handled through [safe outputs](/gh-aw/reference/safe-outputs/), which run in a separate permission-controlled job.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

Minor grammar: “always operates read-only” reads awkwardly. Consider “always operates in read-only mode” for clarity/consistency with the linked reference docs.

Suggested change
The GitHub MCP server always operates read-only. Write operations are handled through [safe outputs](/gh-aw/reference/safe-outputs/), which run in a separate permission-controlled job.
The GitHub MCP server always operates in read-only mode. Write operations are handled through [safe outputs](/gh-aw/reference/safe-outputs/), which run in a separate permission-controlled job.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants