[docs] docs: unbloat gh-aw MCP server reference - #50429
Conversation
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped. |
|
Great work on cleaning up the MCP server reference documentation! 👍 This PR demonstrates excellent execution of the documentation unbloat 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.
|
There was a problem hiding this comment.
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
jqinput and drops four currently supported scanners (runner-guard,syft,grype, andyamllint). Since this is the replacement reference for the removed parameter catalog, keep it aligned withcompileArgs.
| `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_tokensis deprecated and ignored,jqis not inlogsArgs, and normal results are written to a JSON file while the MCP response returns itsfile_path; continuation data is inside that file. It also omits the activefiltered_integrityfilter.
| `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-diffMCP tool even though the page still identifies it as privileged, and theauditrow advertises unsupportedjqinput. 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, andyamllint. 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`. | |
|
🎉 This pull request is included in a new release. Release: |
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
Impact