[azsdk-cli] Refactor CLI command classes and remove output helper usage (#12125)

* [azsdk-cli] Support returning a command list for tool classes

* Update tool classes to use multi command and SetHandlers

Author: benbp

tools/azsdk-cli/Azure.Sdk.Tools.Cli.Analyzer/EnforceToolsList.cs

@@ -74,7 +74,7 @@ public override void Initialize(AnalysisContext context)
                         return;
                     }
 
-                    var baseTool = symCtx.Compilation.GetTypeByMetadataName("Azure.Sdk.Tools.Cli.Contract.MCPTool");
+                    var baseTool = symCtx.Compilation.GetTypeByMetadataName("Azure.Sdk.Tools.Cli.Contract.MCPToolBase");
                     if (baseTool != null && InheritsFrom(named, baseTool))
                     {
                         implementations.Add(named);

tools/azsdk-cli/Azure.Sdk.Tools.Cli.Analyzer/EnforceToolsReturnTypes.cs

@@ -159,7 +159,7 @@ private static bool IsValidReturnType(ITypeSymbol returnType, Compilation compil
             }
 
             // Check if it implements Response (look in Azure.Sdk.Tools.Cli.Models namespace)
-            var responseType = compilation.GetTypeByMetadataName("Azure.Sdk.Tools.Cli.Models.Response");
+            var responseType = compilation.GetTypeByMetadataName("Azure.Sdk.Tools.Cli.Models.CommandResponse");
             if (responseType != null && InheritsFromOrImplements(returnType, responseType))
             {
                 return true;

tools/azsdk-cli/Azure.Sdk.Tools.Cli.Analyzer/README.md

@@ -53,7 +53,7 @@ public async Task<Response> ProcessData(string myArg)
 
 ## Overview
 
-The `EnforceToolsListAnalyzer` ensures that every class inheriting from `MCPTool` is properly registered in the `SharedOptions.ToolsList` static list, otherwise they will not be loaded at startup.
+The `EnforceToolsListAnalyzer` ensures that every class inheriting from `MCPToolBase` is properly registered in the `SharedOptions.ToolsList` static list, otherwise they will not be loaded at startup.
 
 All non-abstract classes that inherit from `Azure.Sdk.Tools.Cli.Contract.MCPTool` must be included as `typeof(ClassName)` entries in the `SharedOptions.ToolsList` static field (`Azure.Sdk.Tools.Cli/Commands/SharedOptions.cs`).
 
@@ -72,7 +72,7 @@ When you encounter MCP002 violations:
 // 1. Tool implementation
 public class MyCustomTool : MCPTool
 {
-    public override Command GetCommand() { /* implementation */ }
+    protected override Command GetCommand() { /* implementation */ }
     public override Task HandleCommand(InvocationContext ctx, CancellationToken ct) { /* implementation */ }
 }
 
@@ -92,7 +92,7 @@ public static readonly List<Type> ToolsList = [
 The `EnforceToolsReturnTypesAnalyzer` ensures that all public non-static methods in classes within
 the `Azure.Sdk.Tools.Cli.Tools` namespace return only approved types at compile time.
 
-This excludes inherited methods `GetCommand`, `HandleCommand`, etc.
+This excludes inherited methods `GetCommand`, `GetCommands`, `HandleCommand`, etc.
 
 ## Allowed Return Types
 

tools/azsdk-cli/Azure.Sdk.Tools.Cli.Contract/Azure.Sdk.Tools.Cli.Contract.csproj

@@ -22,32 +22,31 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\Azure.Sdk.Tools.Cli.Contract\Azure.Sdk.Tools.Cli.Contract.csproj" />
-    <ProjectReference Include="..\Azure.Sdk.Tools.Cli\Azure.Sdk.Tools.Cli.csproj" />
+    <ProjectReference Include="../Azure.Sdk.Tools.Cli/Azure.Sdk.Tools.Cli.csproj" />
   </ItemGroup>
 
   <ItemGroup>
     <Using Include="NUnit.Framework" />
   </ItemGroup>
 
   <ItemGroup>
-    <None Include="TestAssets\**\*" CopyToOutputDirectory="PreserveNewest" />
+    <None Include="TestAssets/**/*" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
-  <ItemGroup>
-    <None Include="..\Azure.Sdk.Tools.Cli\Templates\ReadMeGenerator\README-template.go.md" Link="TestAssets\README-template.go.md">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
+  <ItemGroup>
+    <None Include="../Azure.Sdk.Tools.Cli/Templates/ReadMeGenerator/README-template.go.md" Link="TestAssets/README-template.go.md">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="TypeSpecTestData\specification\testcontoso\Contoso.Management\employee.tsp">
+    <None Update="TypeSpecTestData/specification/testcontoso/Contoso.Management/employee.tsp">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
-    <None Update="TypeSpecTestData\specification\testcontoso\Contoso.Management\main.tsp">
+    <None Update="TypeSpecTestData/specification/testcontoso/Contoso.Management/main.tsp">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
-    <None Update="TypeSpecTestData\specification\testcontoso\Contoso.Management\tspconfig.yaml">
+    <None Update="TypeSpecTestData/specification/testcontoso/Contoso.Management/tspconfig.yaml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
   </ItemGroup>

tools/azsdk-cli/Azure.Sdk.Tools.Cli.Contract/CommandGroup.cs

@@ -5,10 +5,10 @@ namespace Azure.Sdk.Tools.Cli.Tests.Helpers;
 
 internal class OutputHelperTests
 {
-  private readonly string summary = "a test summary";
-  private readonly List<LogEntry> errors =
-  [
-      new LogEntry
+    private readonly string summary = "a test summary";
+    private readonly List<LogEntry> errors =
+    [
+        new LogEntry
         {
             File = "file1",
             Line = 1,
@@ -20,13 +20,13 @@ internal class OutputHelperTests
             Line = 2,
             Message = "message2"
         }
-  ];
-  private readonly string suggestedFix = "a test suggested fix";
+    ];
+    private readonly string suggestedFix = "a test suggested fix";
 
-  [Test]
-  public void TestTypedJsonOutput()
-  {
-    var json = @"{
+    [Test]
+    public void TestTypedJsonOutput()
+    {
+        var json = @"{
   ""summary"": ""a test summary"",
   ""errors"": [
     {
@@ -43,23 +43,23 @@ public void TestTypedJsonOutput()
   ""suggested_fix"": ""a test suggested fix""
 }";
 
-    var output = new OutputHelper(OutputModes.Json);
-    var formatted = output.ValidateAndFormat<LogAnalysisResponse>(json);
+        var output = new OutputHelper(OutputHelper.OutputModes.Json);
+        var formatted = output.ValidateAndFormat<LogAnalysisResponse>(json);
 
-    Assert.That(formatted, Is.EqualTo(json));
-  }
+        Assert.That(formatted, Is.EqualTo(json));
+    }
 
-  [Test]
-  public void TestPlainTextOutput()
-  {
-    var response = new LogAnalysisResponse
+    [Test]
+    public void TestPlainTextOutput()
     {
-      Summary = summary,
-      Errors = errors,
-      SuggestedFix = suggestedFix
-    };
+        var response = new LogAnalysisResponse
+        {
+            Summary = summary,
+            Errors = errors,
+            SuggestedFix = suggestedFix
+        };
 
-    var expectedStr = @"
+        var expectedStr = @"
 ### Summary:
 a test summary
 
@@ -74,9 +74,9 @@ a test suggested fix
 message2
 ".TrimStart();
 
-    var output = new OutputHelper(OutputModes.Plain);
-    var formatted = output.Format(response);
+        var output = new OutputHelper(OutputHelper.OutputModes.Plain);
+        var formatted = output.Format(response);
 
-    Assert.That(formatted, Is.EqualTo(expectedStr));
-  }
+        Assert.That(formatted, Is.EqualTo(expectedStr));
+    }
 }