Skip to content

[docs] docs: reduce bloat in gh-aw-as-mcp-server reference#22339

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-gh-aw-as-mcp-server-a5143a1068ac79ce
Mar 23, 2026
Merged

[docs] docs: reduce bloat in gh-aw-as-mcp-server reference#22339
pelikhan merged 1 commit intomainfrom
docs/unbloat-gh-aw-as-mcp-server-a5143a1068ac79ce

Conversation

@github-actions
Copy link
Contributor

Cleans up docs/src/content/docs/reference/gh-aw-as-mcp-server.md, reducing it from 308 → 208 lines (−33%) while preserving all essential information.

What was improved

Introduction — condensed two-sentence opener into one.

Actor Validation section — replaced two parallel bullet lists ("When enabled:" / "When disabled:") plus separate "Environment Variables" and "Permission Requirements" sub-headings with a single concise paragraph (~20 lines → 3 lines).

Available Tools section — removed the repetitive **Parameters:** / **Returns:** heading pattern repeated for each of the 7 tools. Parameters are now listed directly; return shapes are summarised inline (e.g. "Returns a JSON array with workflow, valid, errors…"). No parameter or return field was dropped.

Self-management section — tightened the introductory sentence.

What was preserved

All configuration options, all tool parameter names and types, all return field names, all code examples, and all cross-links are unchanged.

Issues

Screenshots could not be captured. The Playwright container (running with --network host) was unable to reach the Astro dev server on the agent container's bridge IP (172.30.0.20:4321) — connections timed out (ERR_CONNECTION_TIMED_OUT). No screenshot files were generated, so no upload_asset call was made.

References:

🗜️ Compressed by Documentation Unbloat ·

  • expires on Mar 25, 2026, 12:14 AM UTC

…33%)

Condense repetitive patterns in the Available Tools section: removed
separate Parameters/Returns headings and bullet lists in favour of
concise inline descriptions; condensed the Actor Validation section from
two parallel bullet lists into a single paragraph; tightened the
introduction sentence.

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 23, 2026
@pelikhan pelikhan marked this pull request as ready for review March 23, 2026 00:19
Copilot AI review requested due to automatic review settings March 23, 2026 00:19
@pelikhan pelikhan merged commit 992735d into main Mar 23, 2026
1 check passed
@pelikhan pelikhan deleted the docs/unbloat-gh-aw-as-mcp-server-a5143a1068ac79ce branch March 23, 2026 00:19
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 verbosity in the GH-AW MCP server reference doc while aiming to preserve the same functional guidance for configuring and using gh aw mcp-server.

Changes:

  • Condensed the introduction and Actor Validation section into shorter prose.
  • Streamlined the “Available Tools” reference by removing repeated “Parameters/Returns” headings and summarizing return shapes inline.
  • Tightened wording in the self-management (“Using GH-AW as an MCP from an Agentic Workflow”) section.
Comments suppressed due to low confidence (1)

docs/src/content/docs/reference/gh-aw-as-mcp-server.md:182

  • The update tool section no longer documents what the tool returns (it previously described the formatted text output and included key items like extension update status and compilation status). Please restore a brief return summary so readers know what to expect.
### `update`

Update workflows from their source repositories and check for gh-aw updates.

- `workflows` (optional): Array of workflow IDs to update (empty for all)
- `major` (optional): Allow major version updates
- `force` (optional): Force update even if no changes detected

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


- Minimum role: write, maintain, or admin
- Permission check via GitHub API: `GET /repos/{owner}/{repo}/collaborators/{username}/permission`
When enabled, the logs and audit tools require write/maintain/admin repository access. The server reads `GITHUB_ACTOR` and `GITHUB_REPOSITORY` env vars and caches permission check results for 1 hour. Without validation (default), all tools are available without checks.
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

The condensed actor validation paragraph no longer states which environment variables are required vs optional when --validate-actor is enabled (previously GITHUB_ACTOR was required and GITHUB_REPOSITORY optional/recommended). Consider adding a short clarification here so users can reliably configure validation, especially in non-GitHub Actions environments.

Suggested change
When enabled, the logs and audit tools require write/maintain/admin repository access. The server reads `GITHUB_ACTOR` and `GITHUB_REPOSITORY` env vars and caches permission check results for 1 hour. Without validation (default), all tools are available without checks.
When enabled, the logs and audit tools require write/maintain/admin repository access. The server requires the `GITHUB_ACTOR` env var and optionally uses `GITHUB_REPOSITORY` (recommended, especially outside GitHub Actions) to scope permission checks, caching results for 1 hour. Without validation (default), all tools are available without checks.

Copilot uses AI. Check for mistakes.
Comment on lines 168 to 175
### `add`

Add workflows from remote repositories to `.github/workflows`.

**Parameters:**

- `workflows` (required): Array of workflow specifications
- Format: `owner/repo/workflow-name` or `owner/repo/workflow-name@version`
- `workflows` (required): Array of workflow specs in `owner/repo/workflow-name[@version]` format
- `number` (optional): Create multiple numbered copies
- `name` (optional): Specify name for added workflow (without .md extension)

**Returns:** Formatted text output showing added workflows.
- `name` (optional): Name for added workflow (without `.md` extension)

Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

The add tool section no longer documents what the tool returns. Other tools in this reference include a one-line return summary; please add a similar return description for consistency and to match the PR description that return shapes are summarized inline.

This issue also appears on line 176 of the same file.

Copilot uses AI. Check for mistakes.
- List of workflow files processed
- Which codemods were applied to each file
- Summary of fixes applied
Available codemods: `timeout-minutes-migration`, `network-firewall-migration`, `sandbox-agent-false-removal`, `mcp-scripts-mode-removal`.
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

The fix tool's codemod list now only includes codemod IDs without describing what each codemod does. That makes it hard for users to choose the right codemod; consider re-adding brief per-codemod descriptions (even as short phrases) while keeping the section compact.

Suggested change
Available codemods: `timeout-minutes-migration`, `network-firewall-migration`, `sandbox-agent-false-removal`, `mcp-scripts-mode-removal`.
Available codemods: `timeout-minutes-migration` (migrate timeout settings to the current format), `network-firewall-migration` (update network firewall configuration), `sandbox-agent-false-removal` (remove redundant `sandbox_agent: false` flags), `mcp-scripts-mode-removal` (remove deprecated MCP script mode options).

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