Migrate AppConfig tools to new tool design#2871
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the Azure App Configuration tool commands from the legacy RegisterOptions/BindOptions(ParseResult) pattern to the newer attribute-based options model ([Option] on POCOs) and SubscriptionCommand<TOptions, TResult> execution, aligning AppConfig with the newer tool design used elsewhere in the repo.
Changes:
- Refactors AppConfig commands to use typed options +
SubscriptionCommand<,>(injectingISubscriptionResolver) instead of parsingParseResult. - Replaces legacy AppConfig option definition/base option types with
[Option]-annotated options POCOs and shared description constants. - Updates AppConfig unit tests to use
SubscriptionCommandUnitTestsBaseto satisfy the new subscription resolver dependency.
Invoking Livetests
Copilot submitted PRs are not trustworthy by default. Users with write access to the repo need to validate the contents of this PR before leaving a comment with the text /azp run mcp - pullrequest - live. This will trigger the necessary livetest workflows to complete required validation.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/Azure.Mcp.Tools.AppConfig/tests/Azure.Mcp.Tools.AppConfig.Tests/KeyValue/KeyValueSetCommandTests.cs | Switches test base class to support new subscription-aware command pattern. |
| tools/Azure.Mcp.Tools.AppConfig/tests/Azure.Mcp.Tools.AppConfig.Tests/KeyValue/KeyValueGetCommandTests.cs | Switches test base class to support new subscription-aware command pattern. |
| tools/Azure.Mcp.Tools.AppConfig/tests/Azure.Mcp.Tools.AppConfig.Tests/KeyValue/KeyValueDeleteCommandTests.cs | Switches test base class to support new subscription-aware command pattern. |
| tools/Azure.Mcp.Tools.AppConfig/tests/Azure.Mcp.Tools.AppConfig.Tests/Account/AccountListCommandTests.cs | Switches test base class to support new subscription-aware command pattern. |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/KeyValue/Lock/KeyValueLockSetOptions.cs | Migrates lock options to [Option]-based POCO binding. |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/KeyValue/KeyValueSetOptions.cs | Migrates set options to [Option]-based POCO binding (including tags/value/content-type). |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/KeyValue/KeyValueGetOptions.cs | Migrates get options to [Option]-based POCO binding (key/filters). |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/KeyValue/KeyValueDeleteOptions.cs | Migrates delete options to [Option]-based POCO binding. |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/KeyValue/BaseKeyValueOptions.cs | Removes legacy base options type (no longer needed with POCO binding). |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/BaseAppConfigOptions.cs | Removes legacy base options type (superseded by POCO binding). |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/AppConfigOptionDescriptions.cs | Adds shared option description constants for AppConfig options. |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/AppConfigOptionDefinitions.cs | Removes legacy System.CommandLine.Option definitions (superseded by POCO binding). |
| tools/Azure.Mcp.Tools.AppConfig/src/Options/Account/AccountListOptions.cs | Migrates account list options to [Option]-based POCO binding. |
| tools/Azure.Mcp.Tools.AppConfig/src/GlobalUsings.cs | Removes global usings that are no longer needed after migration away from direct System.CommandLine usage in commands. |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/KeyValue/Lock/KeyValueLockSetCommand.cs | Refactors command to typed options + SubscriptionCommand<,> and seals result record. |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/KeyValue/KeyValueSetCommand.cs | Refactors command to typed options + SubscriptionCommand<,> and seals result record. |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/KeyValue/KeyValueGetCommand.cs | Refactors command to typed options + SubscriptionCommand<,> and moves validation to ValidateOptions. |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/KeyValue/KeyValueDeleteCommand.cs | Refactors command to typed options + SubscriptionCommand<,> and seals result record. |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/KeyValue/BaseKeyValueCommand.cs | Removes legacy base command class (no longer needed with POCO binding). |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/BaseAppConfigCommand.cs | Removes legacy base command class (no longer needed with POCO binding). |
| tools/Azure.Mcp.Tools.AppConfig/src/Commands/Account/AccountListCommand.cs | Refactors command to typed options + SubscriptionCommand<,> and seals result record. |
| servers/Azure.Mcp.Server/changelog-entries/1781294298905.yaml | Adds a changelog entry for the AppConfig tool change. |
| /// <summary> | ||
| /// Common option descriptions for App Configuration. | ||
| /// </summary> | ||
| public static class AppConfigOptionDescriptions |
vcolin7
left a comment
There was a problem hiding this comment.
LGTM for the most part. Just left a few comments :)
| options.Account, | ||
| options.Key, |
| if (!Validate(parseResult.CommandResult, context.Response).IsValid) | ||
| validationResult.Errors.Add("Cannot specify both --key and --key-filter options together. Use only one to get a specific key-value or to filter the list of key-values."); | ||
| } | ||
| if (!string.IsNullOrEmpty(options.Label) && !string.IsNullOrEmpty(options.LabelFilter)) |
There was a problem hiding this comment.
Maybe we should mention this validation update in the changelog entry either as a bug fix or breaking change.
| { | ||
| var settings = await _appConfigService.GetKeyValues( | ||
| options.Account!, | ||
| options.Account, |
There was a problem hiding this comment.
Are we not checking for requiredness here anymore because we do so when binding options?
| options.Account, | ||
| options.Key, | ||
| options.Value, |
There was a problem hiding this comment.
Same question about requiredness/nullability.
| /// <summary> | ||
| /// Common option descriptions for App Configuration. | ||
| /// </summary> | ||
| public static class AppConfigOptionDescriptions |
What does this PR do?
Migrates AppConfig tools to new design where Register and Bind options are based on
Optionattributes.GitHub issue number?
[Link to the GitHub issue this PR addresses]Pre-merge Checklist
servers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentationREADME.mdchanges running the script./eng/scripts/Process-PackageReadMe.ps1. See Package READMEToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test promptsconsolidated-tools.jsonbreaking-changelabelservers/Azure.Mcp.Server/docs/azmcp-commands.md./eng/scripts/Update-AzCommandsMetadata.ps1to update tool metadata inazmcp-commands.md(required for CI)servers/Azure.Mcp.Server/docs/e2eTestPrompts.mdcrypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline