Skip to content

Migrate App Lens tools to new tool design#2872

Open
alzimmermsft wants to merge 3 commits into
microsoft:mainfrom
alzimmermsft:MigrateAppLensToNewToolDesign
Open

Migrate App Lens tools to new tool design#2872
alzimmermsft wants to merge 3 commits into
microsoft:mainfrom
alzimmermsft:MigrateAppLensToNewToolDesign

Conversation

@alzimmermsft

Copy link
Copy Markdown
Contributor

What does this PR do?

Migrates App Lens tools to new design where Register and Bind options are based on Option attributes.

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

Migrates the AppLens tool command(s) to the newer command/options design where CLI options are derived from [Option] attributes and bound via the shared OptionBinder, removing the legacy manual RegisterOptions/BindOptions flow.

Changes:

  • Converted ResourceDiagnoseCommand to the new BaseCommand<TOptions, TResult>-style execution signature and removed manual option registration/binding.
  • Replaced the GlobalOptions-derived options model and deleted the legacy AppLensOptionDefinitions option definitions.
  • Removed AppLens tool GlobalUsings.cs and added explicit System.Text.Json usings where needed; added a breaking-change changelog entry.

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 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tools/Azure.Mcp.Tools.AppLens/src/Services/AppLensService.cs Adds explicit System.Text.Json import after removal of AppLens global usings.
tools/Azure.Mcp.Tools.AppLens/src/Options/Resource/ResourceDiagnoseOptions.cs Introduces attribute-based option definitions and removes GlobalOptions inheritance.
tools/Azure.Mcp.Tools.AppLens/src/Options/AppLensOptionDefinitions.cs Deletes legacy System.CommandLine option definitions.
tools/Azure.Mcp.Tools.AppLens/src/Models/AppLensModels.cs Adds explicit System.Text.Json import after global usings removal.
tools/Azure.Mcp.Tools.AppLens/src/Models/AppLensJsonContext.cs Adds explicit System.Text.Json import after global usings removal.
tools/Azure.Mcp.Tools.AppLens/src/GlobalUsings.cs Removes AppLens-specific global usings (System.CommandLine, System.Text.Json).
tools/Azure.Mcp.Tools.AppLens/src/Commands/Resource/ResourceDiagnoseCommand.cs Migrates to new command base/signature and removes manual option plumbing.
servers/Azure.Mcp.Server/changelog-entries/1781295131142.yaml Adds a breaking-changes entry for the AppLens parameter surface change.

Comment on lines 29 to 31
public sealed class ResourceDiagnoseCommand(ILogger<ResourceDiagnoseCommand> logger, IAppLensService appLensService)
: GlobalCommand<ResourceDiagnoseOptions>
: BaseCommand<ResourceDiagnoseOptions, ResourceDiagnoseCommandResult>
{
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

2 participants