Skip to content

Fix init command documentation - clarify MCP enabled by default#7303

Merged
pelikhan merged 3 commits intomainfrom
copilot/fix-cli-init-command-docs
Dec 22, 2025
Merged

Fix init command documentation - clarify MCP enabled by default#7303
pelikhan merged 3 commits intomainfrom
copilot/fix-cli-init-command-docs

Conversation

Copy link
Contributor

Copilot AI commented Dec 22, 2025

Documentation showed --mcp as an opt-in flag, but source code (init_command.go:74-80) has MCP enabled by default with --mcp hidden for backward compatibility.

Changes

  • docs/src/content/docs/setup/cli.md: Updated examples from gh aw init --mcp to gh aw init (default) and gh aw init --no-mcp (skip MCP)
  • docs/src/content/docs/setup/mcp-server.md: Removed --mcp from 2 locations, added clarification about default behavior
  • install.md: Updated 2 references to use correct syntax

Before/After

# Before (incorrect)
gh aw init --mcp # Also setup MCP server integration

# After (correct)
gh aw init         # MCP enabled by default
gh aw init --no-mcp # Skip MCP server integration

The --mcp flag remains functional but hidden for backward compatibility.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Inconsistent init command description between source and documentation</issue_title>
<issue_description>## Issue Description

Command: gh aw init
Type: Documentation inconsistency
Priority: Medium

Current Output (from source code: pkg/cli/init_command.go line 148-149)

Short: "Initialize repository for agentic workflows"

Documentation (docs/src/content/docs/setup/cli.md line 147)

The documentation says:

gh aw init --mcp # Also setup MCP server integration for Copilot Agent

Issue

The documentation uses the deprecated --mcp flag in the example, but according to the source code (lines 74-80 of init_command.go), the flag behavior has changed:

// Determine MCP state: default true, unless --no-mcp is specified
// --mcp flag is kept for backward compatibility (hidden from help)
mcp := !noMcp
if cmd.Flags().Changed("mcp") {
    // If --mcp is explicitly set, use it (backward compatibility)
    mcp = mcpFlag
}

The --mcp flag is hidden and kept only for backward compatibility. The current default is to enable MCP unless --no-mcp is specified.

Suggested Fix

Update the documentation example to:

gh aw init         # Configure .gitattributes, Copilot instructions (MCP enabled by default)
gh aw init --no-mcp # Skip MCP server integration

Or update the description to clarify that MCP is enabled by default:

Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, sets up prompt files for workflow creation, and creates `.github/aw/logs/.gitignore` to prevent workflow logs from being committed. MCP server integration is enabled by default. Use `--no-mcp` to skip creating GitHub Actions workflow for MCP server setup and VS Code integration.

AI generated by CLI Consistency Checker

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits December 22, 2025 18:00
…f --mcp

Update documentation to reflect that MCP is enabled by default:
- cli.md: Show `gh aw init` as default with MCP, `--no-mcp` to skip
- mcp-server.md: Remove deprecated `--mcp` flag from examples (2 locations)
- Clarify that `--mcp` is kept for backward compatibility but hidden

Fixes inconsistency between source code (pkg/cli/init_command.go lines 74-80)
and documentation where --mcp was incorrectly shown as opt-in flag.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Remove deprecated --mcp flag from install wizard documentation:
- Line 13: Example command narration
- Line 84: Step 2 initialization command

Both locations now correctly show `gh aw init` without --mcp flag,
with note that MCP is enabled by default.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix inconsistent init command description in documentation Fix init command documentation - clarify MCP enabled by default Dec 22, 2025
Copilot AI requested a review from mnkiefer December 22, 2025 18:05
@pelikhan pelikhan marked this pull request as ready for review December 22, 2025 19:25
@pelikhan pelikhan merged commit 71ae76d into main Dec 22, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/fix-cli-init-command-docs branch December 22, 2025 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] Inconsistent init command description between source and documentation

3 participants

Comments