Merged
Conversation
g2vinay
requested review from
JasonYeMSFT,
chidozieononiwu,
Copilot,
fanyang-mono,
hallipr,
jairmyree,
msalaman and
vukelich
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new documentation file docs/tool-rename-checklist.md that defines a step-by-step checklist for renaming existing MCP tools. Since tool names form part of the MCP protocol surface, renames are breaking changes, and this checklist aims to ensure all necessary updates are made consistently.
Changes:
- Adds a new
docs/tool-rename-checklist.mdwith a 7-step checklist covering source code, docs, recordings, unit tests, changelog, spelling, and final verification. - Documents what constitutes a tool rename and why renames are breaking changes.
joshfree
reviewed
Mar 6, 2026
Member
joshfree
left a comment
joshfree
left a comment
There was a problem hiding this comment.
Please update the PR template to have another checkbox and link to this new document
joshfree
approved these changes
Mar 6, 2026
github-project-automation
Bot
moved this from Untriaged
to In Progress
in Azure MCP Server
anannya03
approved these changes
Mar 9, 2026
colbytimm
pushed a commit
to colbytimm/microsoft-mcp
that referenced
this pull request
Apr 20, 2026
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.
This PR adds tool-rename-checklist.md, a new reference document that defines the required steps when renaming an existing MCP tool.
A checklist covering all the areas that must be updated when changing a tool's name (i.e., the Name property on a command or its parent group):
Source code — Name, Id, filename, Title, Description, option definitions, and build verification
Docs — azmcp-commands.md, e2eTestPrompts.md, and a full-repo search for old name references
Recordings — deleting/re-recording session files and pushing updated assets
Unit tests — updating arg strings, class names, and confirming tests pass
Changelog — creating a Breaking Changes entry via New-ChangelogEntry.ps1
Spelling — running Invoke-Cspell.ps1 and updating cspell.json if needed
Final verification — PR labeling, description requirements, and reviewer guidance