Skip to content

Additional Option binding updates#2922

Merged
alzimmermsft merged 8 commits into
microsoft:mainfrom
alzimmermsft:OptionBindingAdditionalFollowups
Jun 23, 2026
Merged

Additional Option binding updates#2922
alzimmermsft merged 8 commits into
microsoft:mainfrom
alzimmermsft:OptionBindingAdditionalFollowups

Conversation

@alzimmermsft

Copy link
Copy Markdown
Contributor

What does this PR do?

  • Splits out complex type handling to [OptionContainer] attribute so [Option] doesn't perform double duty.
  • Now that [Option] doesn't need to support complex type handling, remove constructors and mark Description as a required property. Updated guidance and source code accordingly.
  • Added back empty or whitespace checking on required string values without a default value supplier.
  • Added support for AllowEmptyOrWhiteSpaceString in [Option] to allow required strings to support specialty cases.
  • Updated binding to account for errors in parsing results. Removed special casing for missing parameters being the response message if they exist as this can mask additional parsing errors (ex, had missing options and an invalid enum value).

GitHub issue number?

[Link to the GitHub issue this PR addresses]

Pre-merge Checklist

  • Required for All PRs
    • Read contribution guidelines
    • PR title clearly describes the change
    • Commit history is clean with descriptive messages (cleanup guide)
    • Added comprehensive tests for new/modified functionality
    • Created a changelog entry if the change falls among the following: new feature, bug fix, UI/UX update, breaking change, or updated dependencies. Follow the changelog entry guide
  • For MCP tool changes:
    • One tool per PR: This PR adds or modifies only one MCP tool for faster review cycles
    • Updated servers/Azure.Mcp.Server/README.md and/or servers/Fabric.Mcp.Server/README.md documentation
    • Validate README.md changes running the script ./eng/scripts/Process-PackageReadMe.ps1. See Package README
    • For new or modified tool descriptions, ran ToolDescriptionEvaluator and obtained a score of 0.4 or more and a top 3 ranking for all related test prompts
    • For tools with new names, including new tools or renamed tools, update consolidated-tools.json
    • For renamed tools, follow the Tool Rename Checklist and tag the PR with the breaking-change label
    • For new tools associated with Azure services or publicly available tools/APIs/products, add URL to documentation in the PR description
  • Extra steps for Azure MCP Server tool changes:
    • Updated command list in servers/Azure.Mcp.Server/docs/azmcp-commands.md
    • Ran ./eng/scripts/Update-AzCommandsMetadata.ps1 to update tool metadata in azmcp-commands.md (required for CI)
    • Updated test prompts in servers/Azure.Mcp.Server/docs/e2eTestPrompts.md
    • 👉 For Community (non-Microsoft team member) PRs:
      • Security review: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (crypto mining, spam, data exfiltration, etc.)
      • Manual tests run: added comment /azp run mcp - pullrequest - live to run Live Test Pipeline

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 updates the shared option-binding system (and many downstream tool option POCOs) to separate complex/nested option handling into a new [OptionContainer] attribute, make [Option].Description required, and improve validation/error reporting during binding.

Changes:

  • Introduces [OptionContainer] for complex/nested option groups (e.g., retry policy), and removes complex-type responsibilities from [Option].
  • Makes [Option].Description required and updates option definitions across multiple toolsets accordingly.
  • Improves binding-time error reporting (includes parse errors) and adds required-string empty/whitespace validation with an escape hatch (AllowEmptyOrWhiteSpaceString), plus adjusts impacted tests/docs.

Reviewed changes

Copilot reviewed 74 out of 74 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
tools/Fabric.Mcp.Tools.OneLake/src/Options/WorkspaceListOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/TableNamespaceListOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/TableNamespaceGetOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/TableListOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/TableGetOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/TableConfigGetOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/PathListOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Options/BlobListOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/Item/OneLakeItemListDfsCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/Item/OneLakeItemListCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/Item/OneLakeItemDataListCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/FileWriteCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/FileReadCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/FileDeleteCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/DirectoryDeleteCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/DirectoryCreateCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/BlobPutCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/BlobGetCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.OneLake/src/Commands/File/BlobDeleteCommand.cs Updates embedded options type to use required Description = ....
tools/Fabric.Mcp.Tools.Docs/tests/Fabric.Mcp.Tools.Docs.Tests/Commands/GetWorkloadDefinitionCommandTests.cs Loosens assertion to tolerate additional parse/bind error text.
tools/Fabric.Mcp.Tools.Docs/tests/Fabric.Mcp.Tools.Docs.Tests/Commands/GetWorkloadApisCommandTests.cs Loosens assertion to tolerate additional parse/bind error text.
tools/Fabric.Mcp.Tools.Docs/tests/Fabric.Mcp.Tools.Docs.Tests/Commands/GetExamplesCommandTests.cs Loosens assertion to tolerate additional parse/bind error text.
tools/Fabric.Mcp.Tools.Docs/tests/Fabric.Mcp.Tools.Docs.Tests/Commands/GetBestPracticesCommandTests.cs Loosens assertion to tolerate additional parse/bind error text.
tools/Fabric.Mcp.Tools.Docs/src/Options/PublicApis/WorkloadCommandOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.Docs/src/Options/BestPractices/GetBestPracticesOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Pipeline/RunPipelineOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Pipeline/ListPipelinesOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Pipeline/GetPipelineOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Pipeline/CreatePipelineOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Dataflow/ListDataflowsOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Dataflow/ExecuteQueryOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.DataFactory/src/Options/Dataflow/CreateDataflowOptions.cs Updates [Option] usage to require Description = ....
tools/Fabric.Mcp.Tools.Core/src/Options/ItemCreateOptions.cs Updates [Option] usage to require Description = ....
tools/Azure.Mcp.Tools.Storage/src/Options/Table/TableListOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Storage/src/Options/Blob/Container/ContainerGetOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Storage/src/Options/Blob/Container/ContainerCreateOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Storage/src/Options/Blob/BlobUploadOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Storage/src/Options/Blob/BlobGetOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Storage/src/Options/Account/AccountGetOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Storage/src/Options/Account/AccountCreateOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Kusto/tests/Azure.Mcp.Tools.Kusto.Tests/QueryCommandTests.cs Removes unused test using import.
tools/Azure.Mcp.Tools.Kusto/src/Options/TableSchemaOptions.cs Standardizes option attributes and cluster option naming (Cluster).
tools/Azure.Mcp.Tools.Kusto/src/Options/TableListOptions.cs Standardizes option attributes and cluster option naming (Cluster).
tools/Azure.Mcp.Tools.Kusto/src/Options/SampleOptions.cs Standardizes option attributes and cluster option naming (Cluster).
tools/Azure.Mcp.Tools.Kusto/src/Options/QueryOptions.cs Standardizes option attributes and cluster option naming (Cluster).
tools/Azure.Mcp.Tools.Kusto/src/Options/IClusterOption.cs Renames interface member to Cluster to match option naming.
tools/Azure.Mcp.Tools.Kusto/src/Options/DatabaseListOptions.cs Standardizes option attributes and cluster option naming (Cluster).
tools/Azure.Mcp.Tools.Kusto/src/Options/ClusterListOptions.cs Standardizes option attributes and retry container handling.
tools/Azure.Mcp.Tools.Kusto/src/Options/ClusterGetOptions.cs Standardizes option attributes and required cluster option naming (Cluster).
tools/Azure.Mcp.Tools.Kusto/src/Commands/TableSchemaCommand.cs Updates option property reference from ClusterName to Cluster.
tools/Azure.Mcp.Tools.Kusto/src/Commands/TableListCommand.cs Updates option property reference from ClusterName to Cluster.
tools/Azure.Mcp.Tools.Kusto/src/Commands/SampleCommand.cs Updates option property reference from ClusterName to Cluster.
tools/Azure.Mcp.Tools.Kusto/src/Commands/QueryCommand.cs Updates option property reference from ClusterName to Cluster.
tools/Azure.Mcp.Tools.Kusto/src/Commands/DatabaseListCommand.cs Updates option property reference from ClusterName to Cluster.
tools/Azure.Mcp.Tools.Kusto/src/Commands/ClusterGetCommand.cs Updates option property reference from ClusterName to Cluster.
tools/Azure.Mcp.Tools.Kusto/src/Commands/BaseClusterCommand.cs Updates validation to require Cluster instead of ClusterName.
tools/Azure.Mcp.Tools.ApplicationInsights/src/Options/RecommendationListOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.AppLens/src/Options/Resource/ResourceDiagnoseOptions.cs Updates [Option] usage to require Description = ....
tools/Azure.Mcp.Tools.AppConfig/src/Options/KeyValue/Lock/KeyValueLockSetOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Aks/src/Options/Nodepool/NodepoolGetOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Aks/src/Options/Cluster/ClusterGetOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Acr/src/Options/Registry/RegistryRepositoryListOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
tools/Azure.Mcp.Tools.Acr/src/Options/Registry/RegistryListOptions.cs Switches nested retry options to [OptionContainer] and updates descriptions.
servers/Azure.Mcp.Server/docs/new-command.md Updates option authoring guidance/examples for required Description and containers.
docs/option-conversion.md Updates option conversion guidance/examples for required Description and containers.
core/Microsoft.Mcp.Core/tests/Microsoft.Mcp.Tests/Client/RecordedCommandTestsBase.cs Refactors live-test-only skipping to shared helper.
core/Microsoft.Mcp.Core/tests/Microsoft.Mcp.Tests/Client/CommandTestsBase.cs Ensures settings are loaded before live-test-only checks; adds helper.
core/Microsoft.Mcp.Core/tests/Microsoft.Mcp.Core.Tests/Options/OptionBinderTests.cs Updates tests for required descriptions; adds new validation tests.
core/Microsoft.Mcp.Core/src/Options/OptionTypeHandler.cs Adds empty/whitespace validation and routes string/enum binding accordingly.
core/Microsoft.Mcp.Core/src/Options/OptionDescriptor.cs Adds [OptionContainer] support and enforces attribute correctness for complex types.
core/Microsoft.Mcp.Core/src/Options/OptionContainerAttribute.cs Adds new attribute to mark complex/nested option containers.
core/Microsoft.Mcp.Core/src/Options/OptionBinder.cs Includes parse errors in binding failures and simplifies validation exception creation.
core/Microsoft.Mcp.Core/src/Options/OptionAttribute.cs Removes constructors and makes Description required; adds empty/whitespace allow flag.
core/Microsoft.Mcp.Core/src/Commands/BaseCommand`2.cs Uses CommandValidationException.Message directly to avoid masking parser errors.

Comment thread core/Microsoft.Mcp.Core/src/Options/OptionTypeHandler.cs Outdated
Comment thread servers/Azure.Mcp.Server/docs/new-command.md Outdated
Comment thread servers/Azure.Mcp.Server/docs/new-command.md Outdated
Comment thread docs/option-conversion.md Outdated
Comment thread core/Microsoft.Mcp.Core/src/Options/OptionBinder.cs
Comment thread docs/option-conversion.md
Comment thread tools/Azure.Mcp.Tools.Kusto/src/Commands/DatabaseListCommand.cs
Comment thread tools/Azure.Mcp.Tools.Kusto/src/Commands/QueryCommand.cs
Comment thread tools/Azure.Mcp.Tools.Kusto/src/Commands/SampleCommand.cs
Comment thread tools/Azure.Mcp.Tools.Kusto/src/Commands/TableListCommand.cs
Comment thread tools/Azure.Mcp.Tools.Kusto/src/Commands/TableSchemaCommand.cs

@vcolin7 vcolin7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! :shipit:

@alzimmermsft alzimmermsft merged commit e201dc6 into microsoft:main Jun 23, 2026
15 checks passed
@alzimmermsft alzimmermsft deleted the OptionBindingAdditionalFollowups branch June 23, 2026 19:22
@github-project-automation github-project-automation Bot moved this from Untriaged to Done in Azure MCP Server Jun 23, 2026
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