Skip to content

[docs] docs: unbloat gh-aw MCP server reference - #50429

Merged
pelikhan merged 1 commit into
mainfrom
docs/unbloat-gh-aw-mcp-server-790ad18d9a9198c2
Aug 5, 2026
Merged

[docs] docs: unbloat gh-aw MCP server reference#50429
pelikhan merged 1 commit into
mainfrom
docs/unbloat-gh-aw-mcp-server-790ad18d9a9198c2

Conversation

@github-actions

@github-actions github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Overview

Condenses the gh aw mcp-server reference documentation to reduce length while preserving all information. Documentation-only change; no code or behavioral changes.

Changes

  • Configuration Options: removed the HTTP Server Mode and Actor Validation subheadings under Configuration Options, replacing them with inline lead-in sentences before the existing code examples. The actor-validation explanation now explicitly lists logs, audit, and audit-diff as the gated tools and clarifies the permission cache never falls back to open access when GITHUB_ACTOR is missing.
  • Available Tools: replaced 9 separate per-tool subsections (status, compile, logs, audit, checks, mcp-inspect, add, update, fix) with a single consolidated markdown table (columns: Tool, Purpose, Key options, Returns). Detail notes on audit run-identifier formats, checks normalized states, and available fix codemods are retained as short paragraphs below the table.
  • VS Code setup: simplified wording from "Configure VS Code Copilot Chat to use gh-aw MCP server:" to "Run gh aw init to configure VS Code Copilot Chat:".

Impact

  • Files changed: 1 (docs/src/content/docs/reference/gh-aw-as-mcp-server.md)
  • No functional or behavioral changes — documentation restructuring only.

Generated by PR Description Updater for #50429 · auto · 33.9 AIC · ⌖ 5.62 AIC · ⊞ 6.9K ·

@github-actions github-actions Bot added automation doc-unbloat documentation Improvements or additions to documentation labels Aug 5, 2026
@pelikhan
pelikhan marked this pull request as ready for review August 5, 2026 01:20
Copilot AI balanced review requested due to automatic review settings August 5, 2026 01:20
@pelikhan
pelikhan merged commit 98c05f2 into main Aug 5, 2026
4 checks passed
@pelikhan
pelikhan deleted the docs/unbloat-gh-aw-mcp-server-790ad18d9a9198c2 branch August 5, 2026 01:21
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Great work on cleaning up the MCP server reference documentation! 👍

This PR demonstrates excellent execution of the documentation unbloat process:

  • Focused and clear — Single file, clear purpose (reduce documentation bloat)
  • Well-described — Comprehensive overview of what changed, why, and impact metrics (~40% reduction while preserving essentials)
  • Preserves critical content — Warnings, links, commands, and examples are all maintained
  • Generated via agentic workflow — This follows the project's core team agentic development process

The PR is well-aligned with the project's contribution standards. All essential documentation elements are preserved while improving readability and reducing noise. This looks ready for review and merge.

Generated by ✅ Contribution Check · ⌖ 6.35 AIC ·

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

Condenses the gh-aw MCP server reference while retaining setup and configuration guidance.

Changes:

  • Simplifies configuration and VS Code setup wording.
  • Replaces per-tool sections with a summary table.
  • Condenses scanner and validation notes.
Show a summary per file
File Description
docs/src/content/docs/reference/gh-aw-as-mcp-server.md Streamlines MCP server configuration and tool reference documentation.

Review details

Tip

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

Suppressed comments (4)

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

  • This option list advertises unsupported jq input and drops four currently supported scanners (runner-guard, syft, grype, and yamllint). Since this is the replacement reference for the removed parameter catalog, keep it aligned with compileArgs.
| `compile` | Compile Markdown workflows to GitHub Actions YAML with optional static analysis. | `workflows`, `strict`, `fix`, `zizmor`, `poutine`, `actionlint`, `grant`, `jq` | JSON array with `workflow`, `valid`, `errors`, `warnings`, `compiled_file`. |

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

  • This row describes the old logs contract. max_tokens is deprecated and ignored, jq is not in logsArgs, and normal results are written to a JSON file while the MCP response returns its file_path; continuation data is inside that file. It also omits the active filtered_integrity filter.
| `logs` | Download and analyze workflow logs with timeout and token guardrails. | `workflow_name`, `count`, `start_date`, `end_date`, `engine`, `firewall`, `no_firewall`, `branch`, `after_run_id`, `before_run_id`, `artifacts`, `timeout`, `max_tokens`, `jq` | JSON run data and metrics, or continuation parameters when a timeout occurs. |

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

  • The table omits the separately registered audit-diff MCP tool even though the page still identifies it as privileged, and the audit row advertises unsupported jq input. Add the backward-compatible tool and document its actual schema so the available-tools table remains complete.
| `audit` | Audit one or more workflow runs; with multiple runs, compare each run to the first. | `run_ids_or_urls` (preferred), `run_id`, deprecated `run_id_or_url`, plus `artifacts`, `experiment`, `variant`, `jq` | Single-run JSON audit or multi-run diff JSON. |

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

  • The first-use image warning is incomplete: the compile preflight also pulls Docker images for runner-guard, syft, grype, and yamllint. Omitting them can make those options' initial retry response unexpected.
> The `actionlint`, `zizmor`, `poutine`, and `grant` scanners used by `compile` pull Docker images on first use. If you see a "Docker images are being downloaded" message, wait 15–30 seconds and retry.
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Balanced

Returns a JSON array with `workflow`, `valid`, `errors`, `warnings`, and `compiled_file` fields.
| Tool | Purpose | Key options | Returns |
| --- | --- | --- | --- |
| `status` | Show workflow and compiled-file status. | `pattern`, `jq` | JSON array with `workflow`, `agent`, `compiled`, `status`, `time_remaining`. |
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.85.1

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