Skip to content

Added ClientName and ToolArea (#2314)#2324

Merged
vcolin7 merged 2 commits intomicrosoft:release/azure/2.xfrom
saikoumudi:cherry-pick-clientname-toolarea
Apr 1, 2026
Merged

Added ClientName and ToolArea (#2314)#2324
vcolin7 merged 2 commits intomicrosoft:release/azure/2.xfrom
saikoumudi:cherry-pick-clientname-toolarea

Conversation

@saikoumudi
Copy link
Copy Markdown
Contributor

@saikoumudi saikoumudi commented Apr 1, 2026

What does this PR do?

[Provide a clear, concise description of the changes]
Added ClientName and ClientType will be deprecated when we see less usage data. Added ToolArea which will be used later. Added unit tests
[Add additional context, screenshots, or information that helps reviewers]

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

* Added ClientName and ClientType will be deprecated when we see less usage data. Added ToolArea which will be used later. Added unit tests

* updated changelog

* Update core/Microsoft.Mcp.Core/src/Areas/Server/Options/PluginTelemetryOptions.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* update required field

* Update core/Azure.Mcp.Core/tests/Azure.Mcp.Core.UnitTests/Areas/Server/Commands/ToolLoading/PluginTelemetryCommandTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* revert back ClientName to be optional to avoid breaking change

* remove toolarea in definition until it's used in telemetry logging. update the description

* update description examples

* update changelog

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 1, 2026 19:11
@saikoumudi saikoumudi requested review from a team as code owners April 1, 2026 19:11
@saikoumudi saikoumudi requested review from JonathanCrd, KarishmaGhiya, jongio and joshfree and removed request for a team April 1, 2026 19:11
@github-project-automation github-project-automation Bot moved this to Untriaged in Azure MCP Server Apr 1, 2026
@saikoumudi saikoumudi enabled auto-merge (squash) April 1, 2026 19:13
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 extends the plugin-telemetry tool’s input surface to capture richer client identity (adding ClientName alongside legacy ClientType) and introduces a placeholder ToolArea field for future use, with corresponding telemetry tagging updates and unit test coverage.

Changes:

  • Add clientName support end-to-end (options model, CLI option definition/binding, telemetry tag emission).
  • Add toolArea as a new PluginTelemetryOptions model property (not yet emitted as telemetry).
  • Add a unit test to validate telemetry tags, and update the Azure MCP Server changelog.

Reviewed changes

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

Show a summary per file
File Description
servers/Azure.Mcp.Server/CHANGELOG.md Adds an unreleased changelog note for the new telemetry fields.
core/Microsoft.Mcp.Core/src/Areas/Server/Options/PluginTelemetryOptions.cs Extends the options model with ClientName and ToolArea JSON properties.
core/Microsoft.Mcp.Core/src/Areas/Server/Options/PluginTelemetryOptionDefinitions.cs Adds --client-name option and deprecates --client-type in description.
core/Microsoft.Mcp.Core/src/Areas/Server/Commands/ToolLoading/PluginTelemetryCommand.cs Registers/binds --client-name and emits a Plugin_ClientName telemetry tag.
core/Azure.Mcp.Core/tests/Azure.Mcp.Core.UnitTests/Areas/Server/Commands/ToolLoading/PluginTelemetryCommandTests.cs Adds a test verifying the activity tags set by LogPluginTelemetry.

Comment thread servers/Azure.Mcp.Server/CHANGELOG.md
@kvenkatrajan
Copy link
Copy Markdown
Contributor

Should I be expecting the whitelisting of toolnames here?

@saikoumudi saikoumudi disabled auto-merge April 1, 2026 19:20
@saikoumudi
Copy link
Copy Markdown
Contributor Author

Should I be expecting the whitelisting of toolnames here?

No Kay. allowlisting toolnames PR is already merged into release branch - #2291

@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure MCP Server Apr 1, 2026
@vcolin7 vcolin7 merged commit 3fa1de4 into microsoft:release/azure/2.x Apr 1, 2026
15 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Azure MCP Server Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants