Skip to content

[cli-consistency] mcp inspect subcommand missing example compared to standalone version #3703

@github-actions

Description

@github-actions

Issue Description

Command: mcp inspect
Type: Inconsistent examples between command definitions
Priority: Medium

Current Code (from pkg/cli/mcp_inspect.go)

There are two separate command definitions for mcp inspect:

  1. Standalone command (line 263-278):
cmd := &cobra.Command{
    Use:   "mcp inspect [workflow-file]",
    Short: "Inspect MCP servers and list available tools, resources, and roots",
    // ...
    Examples:
      gh aw mcp inspect                    # List workflows with MCP servers
      gh aw mcp inspect weekly-research    # Inspect MCP servers in weekly-research.md  
      gh aw mcp inspect repomind --server repo-mind  # Inspect only the repo-mind server
      gh aw mcp inspect weekly-research --server github --tool create_issue  # Show details for a specific tool
      // ... more examples
}
  1. Subcommand version (line 538-552):
cmd := &cobra.Command{
    Use:   "inspect [workflow-file]",
    Short: "Inspect MCP servers and list available tools, resources, and roots",
    // ...
    Examples:
      gh aw mcp inspect                    # List workflows with MCP servers
      gh aw mcp inspect weekly-research    # Inspect MCP servers in weekly-research.md  
      gh aw mcp inspect weekly-research --server github --tool create_issue  # Show details for a specific tool
      // ... more examples (MISSING the --server repo-mind example)
}

Issue

The standalone version includes an example that the subcommand version is missing:

Missing from subcommand version (line 549):

gh aw mcp inspect repomind --server repo-mind  # Inspect only the repo-mind server

This example appears in the standalone version (line 274) but is absent from the subcommand version.

Why This Matters

Users may get different help output depending on how they invoke the command:

  • gh aw mcp inspect --help - shows the standalone version with the extra example
  • gh aw help mcp inspect - might show the subcommand version without the example

This inconsistency can confuse users about available functionality.

Suggested Fix

Add the missing example to the subcommand version at line 549 in pkg/cli/mcp_inspect.go:

Examples:
  gh aw mcp inspect                    # List workflows with MCP servers
  gh aw mcp inspect weekly-research    # Inspect MCP servers in weekly-research.md  
  gh aw mcp inspect repomind --server repo-mind  # Inspect only the repo-mind server  // ADD THIS LINE
  gh aw mcp inspect weekly-research --server github --tool create_issue  # Show details for a specific tool
  gh aw mcp inspect weekly-research -v # Verbose output with detailed connection info
  gh aw mcp inspect weekly-research --inspector  # Launch `@modelcontextprotocol/inspector`
  gh aw mcp inspect weekly-research --check-secrets  # Check GitHub Actions secrets

Files Affected

  • pkg/cli/mcp_inspect.go (line 549 - add missing example)

AI generated by CLI Consistency Checker

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions