Skip to content

Organize CLI --help output#1640

Merged
anannya03 merged 7 commits intomicrosoft:mainfrom
anannya03:organize-cli-help-output
Feb 13, 2026
Merged

Organize CLI --help output#1640
anannya03 merged 7 commits intomicrosoft:mainfrom
anannya03:organize-cli-help-output

Conversation

@anannya03
Copy link
Copy Markdown
Contributor

@anannya03 anannya03 commented Feb 3, 2026

What does this PR do?

  1. Organize the CLI help output in the following categories-
    group CLI contains tools
    group MCP contains server command
    group recommended tools contains best practices
    group subscription management contains subscription, group
    group Azure Services contains individual tools

  2. Add a section for Example which has 1-2 examples of using the commands.

image
  1. Reduce the help output of the commands to be clear and concise.
  2. Enforce a strict <=72 characters per line limit for description in the CLI --help output.

GitHub issue number?

#1457

Copy link
Copy Markdown
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 reorganizes the CLI --help output by introducing command categories and a custom root help renderer, while also re-wrapping many CommandGroup descriptions to fit a consistent line length and adding a validation script for description line length.

Changes:

  • Introduces CommandCategory and adds IAreaSetup.Category to support categorized help output.
  • Replaces the previous version-only help customization with a CustomHelpAction that prints grouped root help output.
  • Reflows many tool CommandGroup descriptions and adds a PowerShell validator (Test-DescriptionLineLength.ps1) wired into Analyze-Code.ps1.

Reviewed changes

Copilot reviewed 61 out of 61 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
tools/Fabric.Mcp.Tools.PublicApi/src/FabricPublicApiSetup.cs Rewraps top-level/group help descriptions for Public API tool.
tools/Fabric.Mcp.Tools.OneLake/src/FabricOneLakeSetup.cs Rewraps help descriptions for OneLake tool command groups.
tools/Azure.Mcp.Tools.Workbooks/src/WorkbooksSetup.cs Rewraps Workbooks tool description.
tools/Azure.Mcp.Tools.VirtualDesktop/src/VirtualDesktopSetup.cs Rewraps Virtual Desktop tool and subgroup descriptions.
tools/Azure.Mcp.Tools.StorageSync/src/StorageSyncSetup.cs Rewrites/rewraps Storage Sync descriptions for readability/length.
tools/Azure.Mcp.Tools.Storage/src/StorageSetup.cs Rewrites/rewraps Storage tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Sql/src/SqlSetup.cs Rewraps SQL tool description.
tools/Azure.Mcp.Tools.Speech/src/SpeechSetup.cs Rewraps Speech tool and STT/TTS subgroup descriptions.
tools/Azure.Mcp.Tools.SignalR/src/SignalRSetup.cs Rewraps SignalR tool and subgroup descriptions.
tools/Azure.Mcp.Tools.ServiceBus/src/ServiceBusSetup.cs Rewraps Service Bus tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Search/src/SearchSetup.cs Rewraps Search tool and subgroup descriptions.
tools/Azure.Mcp.Tools.ResourceHealth/src/ResourceHealthSetup.cs Rewraps Resource Health tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Redis/src/RedisSetup.cs Rewraps Redis tool description.
tools/Azure.Mcp.Tools.Quota/src/QuotaSetup.cs Rewraps Quota tool description.
tools/Azure.Mcp.Tools.Pricing/src/PricingSetup.cs Rewraps Pricing tool description.
tools/Azure.Mcp.Tools.Postgres/src/PostgresSetup.cs Rewraps Postgres tool description.
tools/Azure.Mcp.Tools.Policy/src/PolicySetup.cs Rewraps Policy tool and subgroup descriptions.
tools/Azure.Mcp.Tools.MySql/src/MySqlSetup.cs Rewraps MySQL tool description.
tools/Azure.Mcp.Tools.Monitor/src/MonitorSetup.cs Rewraps Monitor tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Marketplace/src/MarketplaceSetup.cs Rewraps Marketplace tool and subgroup descriptions.
tools/Azure.Mcp.Tools.ManagedLustre/src/ManagedLustreSetup.cs Rewraps Managed Lustre tool and subgroup descriptions.
tools/Azure.Mcp.Tools.LoadTesting/src/LoadTestingSetup.cs Rewraps Load Testing tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Kusto/src/KustoSetup.cs Rewraps Kusto tool and subgroup descriptions.
tools/Azure.Mcp.Tools.KeyVault/src/KeyVaultSetup.cs Rewraps Key Vault tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Grafana/src/GrafanaSetup.cs Rewraps Grafana tool description.
tools/Azure.Mcp.Tools.FunctionApp/src/FunctionAppSetup.cs Rewraps Function App tool description.
tools/Azure.Mcp.Tools.Foundry/src/FoundrySetup.cs Rewraps Foundry tool and subgroup descriptions.
tools/Azure.Mcp.Tools.FileShares/src/FileSharesSetup.cs Rewraps FileShares snapshot subgroup description.
tools/Azure.Mcp.Tools.Extension/src/ExtensionSetup.cs Rewraps Extension tool descriptions and assigns Category.
tools/Azure.Mcp.Tools.EventHubs/src/EventHubsSetup.cs Rewraps Event Hubs tool description.
tools/Azure.Mcp.Tools.EventGrid/src/EventGridSetup.cs Rewraps Event Grid tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Deploy/src/DeploySetup.cs Rewrites long Deploy tool description into wrapped raw string.
tools/Azure.Mcp.Tools.Cosmos/src/CosmosSetup.cs Rewraps Cosmos DB tool and subgroup descriptions.
tools/Azure.Mcp.Tools.ConfidentialLedger/src/ConfidentialLedgerSetup.cs Rewraps Confidential Ledger tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Compute/src/ComputeSetup.cs Rewraps Compute tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Communication/src/CommunicationSetup.cs Rewraps Communication tool and subgroup descriptions.
tools/Azure.Mcp.Tools.CloudArchitect/src/CloudArchitectSetup.cs Rewraps Cloud Architect tool description.
tools/Azure.Mcp.Tools.BicepSchema/src/BicepSchemaSetup.cs Rewraps Bicep schema tool description.
tools/Azure.Mcp.Tools.AzureTerraformBestPractices/src/AzureTerraformBestPracticesSetup.cs Rewraps description and assigns Category.
tools/Azure.Mcp.Tools.AzureMigrate/src/AzureMigrateSetup.cs Rewraps Azure Migrate (landing zone) tool and subgroup descriptions.
tools/Azure.Mcp.Tools.AzureIsv/src/AzureIsvSetup.cs Rewraps Azure ISV (Datadog) tool and subgroup descriptions.
tools/Azure.Mcp.Tools.AzureBestPractices/src/AzureBestPracticesSetup.cs Rewraps Azure Best Practices tool description.
tools/Azure.Mcp.Tools.Authorization/src/AuthorizationSetup.cs Rewraps Authorization tool and subgroup descriptions.
tools/Azure.Mcp.Tools.ApplicationInsights/src/ApplicationInsightsSetup.cs Rewraps Application Insights tool and subgroup descriptions.
tools/Azure.Mcp.Tools.AppService/src/AppServiceSetup.cs Rewraps App Service tool and subgroup descriptions.
tools/Azure.Mcp.Tools.AppLens/src/AppLensSetup.cs Rewrites AppLens description to a shorter wrapped paragraph.
tools/Azure.Mcp.Tools.AppConfig/src/AppConfigSetup.cs Rewraps App Configuration tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Aks/src/AksSetup.cs Rewraps AKS tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Advisor/src/AdvisorSetup.cs Removes BOM + rewraps Advisor tool and subgroup descriptions.
tools/Azure.Mcp.Tools.Acr/src/AcrSetup.cs Rewraps ACR tool and subgroup descriptions.
eng/scripts/Test-DescriptionLineLength.ps1 Adds new script to validate/fix Setup.cs description line lengths.
eng/scripts/Analyze-Code.ps1 Wires description line-length validation into code analysis script.
core/Microsoft.Mcp.Core/src/Areas/IAreaSetup.cs Adds default Category to IAreaSetup.
core/Microsoft.Mcp.Core/src/Areas/CommandCategory.cs Introduces CommandCategory enum for help grouping.
core/Azure.Mcp.Core/src/Commands/CustomHelpAction.cs Adds custom root help renderer with category grouping + wrapping.
core/Azure.Mcp.Core/src/Commands/CommandFactory.cs Switches help action to CustomHelpAction.
core/Azure.Mcp.Core/src/Areas/Tools/ToolsSetup.cs Assigns Category + rewraps Tools area description.
core/Azure.Mcp.Core/src/Areas/Subscription/SubscriptionSetup.cs Assigns Category + rewraps Subscription area description.
core/Azure.Mcp.Core/src/Areas/Server/ServerSetup.cs Assigns Category + rewraps Server area description.
core/Azure.Mcp.Core/src/Areas/Group/GroupSetup.cs Assigns Category + rewraps Group area description.
core/Azure.Mcp.Core/src/Commands/VersionDisplayHelpAction.cs Deleted (replaced by CustomHelpAction).

Comment thread eng/scripts/Test-DescriptionLineLength.ps1 Outdated
Comment thread eng/scripts/Test-DescriptionLineLength.ps1 Outdated
Comment thread tools/Azure.Mcp.Tools.AzureBestPractices/src/AzureBestPracticesSetup.cs Outdated
Comment thread eng/scripts/Analyze-Code.ps1 Outdated
Comment thread core/Azure.Mcp.Core/src/Areas/Group/GroupSetup.cs Outdated
Comment thread core/Microsoft.Mcp.Core/src/Commands/CustomHelpAction.cs Outdated
Comment thread eng/scripts/Test-DescriptionLineLength.ps1 Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants