Skip to content

[Doc Gap] kusto and storage commands — global options table incorrectly claims --auth-method applies after removal in PR #2922 #2934

Description

@github-actions

Documentation Gap

Server: Azure.Mcp.Server
Tool directory: tools/Azure.Mcp.Tools.Kusto, tools/Azure.Mcp.Tools.Storage
Triggered by: commit e201dc69b3 / PR #2922 by @alzimmermsft
Changed files:

  • tools/Azure.Mcp.Tools.Kusto/src/Options/ClusterGetOptions.cs
  • tools/Azure.Mcp.Tools.Kusto/src/Options/ClusterListOptions.cs
  • tools/Azure.Mcp.Tools.Kusto/src/Options/DatabaseListOptions.cs
  • tools/Azure.Mcp.Tools.Kusto/src/Options/QueryOptions.cs
  • tools/Azure.Mcp.Tools.Kusto/src/Options/SampleOptions.cs
  • tools/Azure.Mcp.Tools.Kusto/src/Options/TableListOptions.cs
  • tools/Azure.Mcp.Tools.Kusto/src/Options/TableSchemaOptions.cs
  • tools/Azure.Mcp.Tools.Storage/src/Options/Account/AccountGetOptions.cs
  • tools/Azure.Mcp.Tools.Storage/src/Options/Blob/BlobGetOptions.cs
  • tools/Azure.Mcp.Tools.Storage/src/Options/Blob/BlobUploadOptions.cs
  • tools/Azure.Mcp.Tools.Storage/src/Options/Blob/Container/ContainerCreateOptions.cs
  • tools/Azure.Mcp.Tools.Storage/src/Options/Blob/Container/ContainerGetOptions.cs
  • tools/Azure.Mcp.Tools.Storage/src/Options/Table/TableListOptions.cs

What Changed

PR #2922 removed AuthMethod (--auth-method) from all seven Kusto command option classes and six Storage command option classes. The changelog entry explicitly classifies this as a Breaking Change:

"Removed unused auth-method parameter from Kusto and Storage tools."

All affected option files had this block removed:

[Option(OptionDescriptions.AuthMethod, Name = "auth-method")]
public AuthMethod? AuthMethod { get; set; }

Gaps Found

The Global Options table at the top of azmcp-commands.md states:

"The following options are available for all commands"

and lists `--auth-method` | No | 'credential' | Authentication method ('credential', 'key', 'connectionString').

After PR #2922, the following commands no longer support --auth-method:

  • azmcp kusto cluster get
  • azmcp kusto cluster list
  • azmcp kusto database list
  • azmcp kusto query
  • azmcp kusto sample
  • azmcp kusto table list
  • azmcp kusto table schema
  • azmcp storage account get
  • azmcp storage blob get
  • azmcp storage blob upload
  • azmcp storage blob container create
  • azmcp storage blob container get
  • azmcp storage table list

This gap extends the same pattern already tracked in #2845 (ACR), #2899 (Application Insights), and #2921 (AppLens, AKS). The exceptions note in azmcp-commands.md needs to be updated to include all Kusto and the listed Storage commands.

Files to Update

  • servers/Azure.Mcp.Server/docs/azmcp-commands.md

Context

# Example from tools/Azure.Mcp.Tools.Kusto/src/Options/ClusterGetOptions.cs
-    [Option(OptionDescriptions.AuthMethod, Name = "auth-method")]
-    public AuthMethod? AuthMethod { get; set; }
-
-    [Option(Name = "retry")]
+    [OptionContainer(Prefix = "retry")]
     public RetryPolicyOptions? RetryPolicy { get; set; }

The same pattern was applied to all 13 option files listed above.

📐 Implementation Guide

This section contains step-by-step instructions for a coding agent to implement the changes described above.

Step 1: Modify files

File: servers/Azure.Mcp.Server/docs/azmcp-commands.md

Locate the existing exceptions note after the Global Options table (around line 20–30). Extend the list of commands that do not support --auth-method to include all Kusto and the affected Storage commands.

If an exceptions note already exists from earlier fixes (#2827, #2845, #2899, #2921), append these entries to it. If no note exists yet, add one immediately after the Global Options table:

> **Note:** The following commands do not support `--auth-method`:
> - `cloudarchitect design` — does not support `--subscription`, `--tenant-id`, `--auth-method`, or any `--retry-*` options
> - `acr registry list` and `acr registry repository list` — do not support `--auth-method`
> - `applicationinsights recommendation list` — does not support `--auth-method`
> - `applens resource diagnose` — does not support `--auth-method` or any `--retry-*` options
> - `aks cluster get` and `aks nodepool get` — do not support `--auth-method`
> - `kusto cluster get`, `kusto cluster list`, `kusto database list`, `kusto query`, `kusto sample`, `kusto table list`, `kusto table schema` — do not support `--auth-method`
> - `storage account get`, `storage blob get`, `storage blob upload`, `storage blob container create`, `storage blob container get`, `storage table list` — do not support `--auth-method`

Step 2: Verify documentation structure

servers/Azure.Mcp.Server/docs/azmcp-commands.md — confirm:

  • The Global Options section note lists all the commands above as exceptions to --auth-method
  • The Kusto command signatures are otherwise accurate (no other changes needed)
  • The Storage command signatures are otherwise accurate (no other changes needed)

Step 3: Validate

Run these commands in order. Each must succeed before proceeding to the next:

  1. dotnet build servers/Azure.Mcp.Server/ — confirms the server project compiles cleanly
  2. dotnet build tools/Azure.Mcp.Tools.Kusto/src/ — confirms the Kusto toolset compiles
  3. dotnet build tools/Azure.Mcp.Tools.Storage/src/ — confirms the Storage toolset compiles
  4. dotnet test tools/Azure.Mcp.Tools.Kusto/tests/Azure.Mcp.Tools.Kusto.Tests/ --filter "TestType!=Live" — runs unit tests for Kusto
  5. dotnet test tools/Azure.Mcp.Tools.Storage/tests/Azure.Mcp.Tools.Storage.Tests/ --filter "TestType!=Live" — runs unit tests for Storage
  6. .\eng\common\spelling\Invoke-Cspell.ps1 — checks spelling in modified documentation

Next Steps

Tip

Ready for automated implementation? Assign this issue to @copilot to have Copilot coding agent implement the changes described in the Implementation Guide above

Generated by Documentation Updater · ● 24.6M ·

Metadata

Metadata

Type

No fields configured for Task.

Projects

Status
Untriaged

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions