Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 17, 2025

The mcp and pr commands had inconsistent help text formatting in their "Available subcommands:" sections—using dashes as separators and irregular spacing that didn't match Cobra's auto-generated "Available Commands:" output.

Changes

  • pkg/cli/mcp.go: Removed dashes, aligned 4 subcommands consistently
  • pkg/cli/pr_command.go: Removed dash, adjusted spacing for transfer subcommand

Before/After

  Available subcommands:
-   add        - Add an MCP tool to an agentic workflow
-   list       - List MCP servers defined in agentic workflows
-   list-tools - List available tools for a specific MCP server
-   inspect    - Inspect MCP servers and list available tools, resources, and roots
+   add         Add an MCP tool to an agentic workflow
+   list        List MCP servers defined in agentic workflows
+   list-tools  List available tools for a specific MCP server
+   inspect     Inspect MCP servers and list available tools, resources, and roots

Now matches standard CLI formatting conventions without decorative separators.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] MCP command help text formatting inconsistency</issue_title>
<issue_description>## Issue Description

Type: Help text formatting inconsistency
Priority: Low
Command: mcp

Current Output (from source code)

The mcp command help text in pkg/cli/mcp.go has inconsistent spacing/alignment:

Available subcommands:
  add        - Add an MCP tool to an agentic workflow
  list       - List MCP servers defined in agentic workflows
  list-tools - List available tools for a specific MCP server
  inspect    - Inspect MCP servers and list available tools, resources, and roots

Issue

The subcommand descriptions use different formatting compared to other commands in the codebase:

  1. Uses dashes (-) as separators after the command name
  2. The list-tools command name includes a hyphen, creating visual inconsistency
  3. Spacing is irregular (more spaces after "add" than after "inspect")

Expected Behavior

Consistent formatting across all command help texts. Consider one of these approaches:

Option 1: Remove dashes, use consistent spacing

Available subcommands:
  add          Add an MCP tool to an agentic workflow
  list         List MCP servers defined in agentic workflows
  list-tools   List available tools for a specific MCP server
  inspect      Inspect MCP servers and list available tools, resources, and roots

Option 2: Keep dashes, align them consistently

Available subcommands:
  add        - Add an MCP tool to an agentic workflow
  list       - List MCP servers defined in agentic workflows  
  list-tools - List available tools for a specific MCP server
  inspect    - Inspect MCP servers and list available tools, resources, and roots

Suggested Fix

Recommended: Option 1 (remove dashes) to match the style used in other command help texts in the codebase.

Update pkg/cli/mcp.go lines 18-22 to use consistent formatting without dashes.

Additional Context

This is a minor cosmetic issue that doesn't affect functionality, but maintaining consistent help text formatting across all commands improves the professional appearance of the CLI.

Source Code Reference:

  • pkg/cli/mcp.go - lines 12-22

AI generated by CLI Consistency Checker</issue_description>

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


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Remove dashes and align spacing consistently in "Available subcommands:"
sections to match Cobra's auto-generated "Available Commands:" style.

Changes:
- pkg/cli/mcp.go: Remove dashes, align spacing for 4 subcommands
- pkg/cli/pr_command.go: Remove dash, adjust spacing for transfer subcommand

This improves the professional appearance and consistency of CLI help text.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix help text formatting inconsistency for mcp command Fix help text formatting: remove dashes, align spacing consistently Nov 17, 2025
Copilot AI requested a review from pelikhan November 17, 2025 15:51
Copilot finished work on behalf of pelikhan November 17, 2025 15:51
@pelikhan pelikhan marked this pull request as ready for review November 17, 2025 17:47
Copilot AI review requested due to automatic review settings November 17, 2025 17:47
Copilot finished reviewing on behalf of pelikhan November 17, 2025 18:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves CLI help text formatting consistency by removing decorative dash separators and aligning spacing in subcommand listings for the mcp and pr commands. The changes ensure help text follows standard CLI conventions similar to Cobra's auto-generated output format.

Key changes:

  • Removed dash separators (-) between command names and descriptions
  • Applied consistent spacing alignment across all subcommands
  • Improved visual consistency with standard CLI formatting patterns

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
pkg/cli/mcp.go Removed dashes and aligned spacing for 4 MCP subcommands (add, list, list-tools, inspect)
pkg/cli/pr_command.go Removed dash separator and adjusted spacing for the transfer subcommand

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

@pelikhan pelikhan merged commit c96c5b3 into main Nov 17, 2025
94 of 102 checks passed
@pelikhan pelikhan deleted the copilot/fix-mcp-help-text-formatting branch November 17, 2025 19:19
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] MCP command help text formatting inconsistency

2 participants