Skip to content

Clarify gh aw init docs for Copilot-only agent/MCP artifacts - #52581

Merged
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fix-init-docs
Aug 14, 2026
Merged

Clarify gh aw init docs for Copilot-only agent/MCP artifacts#52581
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fix-init-docs

Conversation

Copilot AI commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

The CLI docs for gh aw init implied MCP/custom-agent artifacts are created unconditionally. Actual behavior is engine-gated: these artifacts are created only when using the Copilot engine.

  • What changed

    • Updated the init section in docs/src/content/docs/setup/cli.md to state:
      • Base behavior always includes .gitattributes + dispatcher skill setup.
      • Copilot-specific behavior (--engine copilot) includes:
        • .github/agents/agentic-workflows.md
        • MCP integration files (unless --no-mcp)
      • Non-Copilot engines skip Copilot-specific artifacts.
  • Docs wording alignment

    • Tightened --no-mcp and --no-agent example comments to explicitly indicate Copilot-engine scope.
    • Kept command options unchanged; this is a behavior-description correction only.
  • Illustrative snippet

    gh aw init --engine claude   # skips Copilot-specific artifacts
    gh aw init --engine copilot  # creates agent + MCP artifacts by default
    gh aw init --no-mcp          # skips MCP integration (Copilot engine)
    gh aw init --no-agent        # skips custom agent (Copilot engine)

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation mismatch for init command in CLI Clarify gh aw init docs for Copilot-only agent/MCP artifacts Aug 13, 2026
Copilot AI requested a review from pelikhan August 13, 2026 20:31
@github-actions

Copy link
Copy Markdown
Contributor

Great work on clarifying the documentation! 🎯

This PR addresses the CLI consistency issue (#52504) by correcting the documentation for gh aw init to accurately reflect the engine-gating behavior. The changes clearly explain that MCP and custom-agent artifacts are created only when using the Copilot engine, which helps users understand the actual CLI behavior.

Why this is solid:

  • ✅ Focused single-file documentation correction
  • ✅ Well-structured PR description with clear before/after examples
  • ✅ Directly fixes a documented high-severity CLI consistency issue
  • ✅ Small, reviewable diff (6 lines total)

The documentation improvements ensure that users won't be confused about which features are engine-specific. Ready for review!

Generated by ✅ Contribution Check · auto · 56.8 AIC · ⌖ 4.08 AIC · ⊞ 8.8K ·

@github-actions

Copy link
Copy Markdown
Contributor

PR Triage

Category: docs · Risk: low · Priority: low · Score: 23/100

Impact Urgency Quality
8/50 5/30 10/20

Recommended action: batch_review (batch: wf-tooling-drafts)

Clarifies that gh aw init's MCP/custom-agent artifact creation is Copilot-engine-gated, not unconditional. Docs-only, draft, no CI yet. Grouped with other draft workflow/tooling PRs for a combined review pass.

Generated by 🔧 PR Triage Agent · auto · 58.4 AIC · ⌖ 2.92 AIC · ⊞ 7.8K ·

@pelikhan
pelikhan marked this pull request as ready for review August 14, 2026 03:07
Copilot AI balanced review requested due to automatic review settings August 14, 2026 03:07
@pelikhan
pelikhan merged commit 08a03b6 into main Aug 14, 2026
1 check passed
@pelikhan
pelikhan deleted the copilot/cli-consistency-fix-init-docs branch August 14, 2026 03:07

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

Clarifies that gh aw init creates agent and MCP artifacts only for the Copilot engine.

Changes:

  • Documents engine-gated initialization behavior.
  • Updates Copilot-specific flag examples.
Show a summary per file
File Description
docs/src/content/docs/setup/cli.md Clarifies Copilot-only initialization artifacts and flags.

Review details

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Suppressed comments (1)

docs/src/content/docs/setup/cli.md:158

  • This command does not select the Copilot engine, so no custom agent would be created even without --no-agent; the example therefore does not demonstrate the flag's behavior. Add --engine copilot to match the engine-gated behavior documented above.
gh aw init --no-agent                   # Skip custom agent creation (Copilot engine)
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Balanced

gh aw init # Initialize repository with defaults (non-interactive)
gh aw init --engine claude # Skip Copilot-specific artifacts
gh aw init --no-mcp # Skip MCP server integration
gh aw init --no-mcp # Skip MCP server integration (Copilot engine)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] CLI Consistency Issues - 2026-08-13

3 participants