Add description to metadata#1043
Merged
Merged
Conversation
anannya03
changed the title
joshfree
added
server-Azure.Mcp
Member
|
cc: @diberry |
Contributor
|
Looks good to me - thank you for doing this so quickly. |
Contributor
Author
|
/azp run mcp - pullrequest - live |
|
Azure Pipelines successfully started running 1 pipeline(s). |
anannya03
requested review from
JasonYeMSFT,
KarishmaGhiya,
alzimmermsft,
Copilot,
fanyang-mono,
hallipr,
joshfree and
wbreza
and removed request for
Copilot
anannya03
force-pushed
the
add_desc_in_metadata
branch
from
d295651 to
28be1ae
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the ToolMetadata class to change metadata properties from simple boolean values to rich objects containing both a value and a description. The changes enable better documentation and understanding of tool behavior by providing human-readable descriptions for each metadata flag.
- Introduces
MetadataDefinitionclass to encapsulate metadata values with descriptions - Updates
ToolMetadataserialization to output objects instead of booleans - Updates PowerShell script to access
.valueproperty from metadata objects
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
MetadataDefinition.cs |
New model class defining metadata structure with value and description properties |
ToolMetadataJsonConverter.cs |
New JSON converter for serializing/deserializing ToolMetadata with MetadataDefinition |
ToolMetadata.cs |
Refactored to use backing fields and expose MetadataDefinition properties for serialization |
ServerJsonContext.cs |
Registered new types for AOT JSON serialization support |
Update-AzCommandsMetadata.ps1 |
Updated to access .value property from metadata objects |
consolidated-tools.json |
Updated JSON format with expanded metadata objects containing values and descriptions |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
anannya03
changed the title
joshfree
reviewed
Nov 5, 2025
joshfree
approved these changes
Nov 5, 2025
fanyang-mono
approved these changes
Nov 5, 2025
KarishmaGhiya
approved these changes
Nov 5, 2025
KarishmaGhiya
approved these changes
Nov 5, 2025
colbytimm
pushed a commit
to colbytimm/microsoft-mcp
that referenced
this pull request
Dec 8, 2025
* add description to metadata * added jsonconverter for sucessful deserialization * addressed review comment * added namespace Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * format * fixed ordering * removed unused usings, copyright * addressed review comments --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds descriptive information for each metadata tool hint property (e.g., destructive, idempotent, etc.) so that content generation tools can produce richer documentation.
Previous
After
GitHub issue number?
#1017
Pre-merge Checklist
servers/Azure.Mcp.Server/CHANGELOG.mdand/orservers/Fabric.Mcp.Server/CHANGELOG.mdfor product changes (features, bug fixes, UI/UX, updated dependencies)servers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentationeng/scripts/Process-PackageReadMe.ps1. See Package README/servers/Azure.Mcp.Server/docs/azmcp-commands.mdand/or/docs/fabric-commands.md.\eng\scripts\Update-AzCommandsMetadata.ps1to update tool metadata in azmcp-commands.md (required for CI)ToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test prompts/servers/Azure.Mcp.Server/docs/e2eTestPrompts.mdcrypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline