Skip to content

Migrate Event Hubs tools to new tool design#3086

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

Migrate Event Hubs tools to new tool design#3086
alzimmermsft wants to merge 3 commits into
microsoft:mainfrom
alzimmermsft:MigrateEventHubsToolsToNewDesign

Conversation

@alzimmermsft

Copy link
Copy Markdown
Contributor

What does this PR do?

Migrates Event Hubs 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

@alzimmermsft alzimmermsft self-assigned this Jul 17, 2026
Copilot AI review requested due to automatic review settings July 17, 2026 18:52
@alzimmermsft
alzimmermsft requested review from a team and jairmyree as code owners July 17, 2026 18:52
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
There may be pipelines that require an authorized user to comment /azp run to run.

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 Event Hubs toolset to the attribute-based options design (auto Register/Bind via [Option]/[OptionContainer]), updating commands/tests/models accordingly to align with the newer SubscriptionCommand<TOptions, TResult> pattern.

Changes:

  • Replaced EventHubsOptionDefinitions + manual RegisterOptions/BindOptions with [Option]-attributed option POCOs across Namespace/EventHub/ConsumerGroup commands.
  • Updated command implementations to the new SubscriptionCommand<TOptions, TResult> shape and adjusted JSON result models/serialization.
  • Updated unit tests to use the newer command test base helpers and direct BindOptions calls.

Reviewed changes

Copilot reviewed 39 out of 39 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/Namespace/NamespaceUpdateCommandTests.cs Updates tests to new subscription command test base + direct BindOptions.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/Namespace/NamespaceGetCommandTests.cs Moves tests to new base and aligns option-name checks with attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/Namespace/NamespaceDeleteCommandTests.cs Updates tests to new base + strongly-typed response deserialization helper.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/EventHub/EventHubUpdateCommandTests.cs Switches to subscription command unit test base.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/EventHub/EventHubDeleteCommandTests.cs Switches to subscription command unit test base.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/ConsumerGroup/ConsumerGroupUpdateCommandTests.cs Switches to subscription command unit test base.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/ConsumerGroup/ConsumerGroupGetCommandTests.cs Switches to subscription command unit test base.
tools/Azure.Mcp.Tools.EventHubs/tests/Azure.Mcp.Tools.EventHubs.Tests/ConsumerGroup/ConsumerGroupDeleteCommandTests.cs Switches to subscription command unit test base.
tools/Azure.Mcp.Tools.EventHubs/src/Options/Namespace/NamespaceUpdateOptions.cs Converts to [Option] attributes + ISubscriptionOption (+ retry container).
tools/Azure.Mcp.Tools.EventHubs/src/Options/Namespace/NamespaceGetOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/Namespace/NamespaceDeleteOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/EventHubsOptionDescriptions.cs Adds shared option description strings for Event Hubs options.
tools/Azure.Mcp.Tools.EventHubs/src/Options/EventHubsOptionDefinitions.cs Removes legacy explicit Option<T> definitions.
tools/Azure.Mcp.Tools.EventHubs/src/Options/EventHub/EventHubUpdateOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/EventHub/EventHubGetOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/EventHub/EventHubDeleteOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/ConsumerGroup/ConsumerGroupUpdateOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/ConsumerGroup/ConsumerGroupGetOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/ConsumerGroup/ConsumerGroupDeleteOptions.cs Converts to [Option] attributes + ISubscriptionOption.
tools/Azure.Mcp.Tools.EventHubs/src/Options/BaseEventHubsOptions.cs Removes legacy shared options base class.
tools/Azure.Mcp.Tools.EventHubs/src/Models/Namespace.cs Removes explicit JsonPropertyName mapping in favor of source-gen + naming policy.
tools/Azure.Mcp.Tools.EventHubs/src/Models/EventHubsSku.cs Removes explicit JsonPropertyName mapping in favor of source-gen + naming policy.
tools/Azure.Mcp.Tools.EventHubs/src/Models/EventHubsModelDefinitions.cs Removes legacy JSON property-name constants.
tools/Azure.Mcp.Tools.EventHubs/src/Models/EventHub.cs Removes explicit JsonPropertyName mapping in favor of source-gen + naming policy.
tools/Azure.Mcp.Tools.EventHubs/src/Models/ConsumerGroup.cs Removes explicit JsonPropertyName mapping in favor of source-gen + naming policy.
tools/Azure.Mcp.Tools.EventHubs/src/GlobalUsings.cs Removes toolset-global usings for legacy command-line/json usage.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/Namespace/NamespaceUpdateCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and validates via ValidateOptions.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/Namespace/NamespaceGetCommand.cs Moves to new command base; consolidates single/list result shape.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/Namespace/NamespaceDeleteCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/EventHubsJsonContext.cs Updates JSON source-gen registrations to match new result types.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/EventHub/EventHubUpdateCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/EventHub/EventHubGetCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/EventHub/EventHubDeleteCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/ConsumerGroup/ConsumerGroupUpdateCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/ConsumerGroup/ConsumerGroupGetCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/ConsumerGroup/ConsumerGroupDeleteCommand.cs Moves to SubscriptionCommand<TOptions, TResult> and attribute-based options.
tools/Azure.Mcp.Tools.EventHubs/src/Commands/BaseEventHubsCommand.cs Removes legacy Event Hubs command base class.
tools/Azure.Mcp.Tools.EventHubs/src/Azure.Mcp.Tools.EventHubs.csproj Updates core reference style and drops direct System.CommandLine package reference.
servers/Azure.Mcp.Server/changelog-entries/1784314320111.yaml Adds a changelog entry for the Event Hubs tool changes.

Comment thread servers/Azure.Mcp.Server/changelog-entries/1784314320111.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tools-EventHubs Event Hubs MCP tools

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants