Clarify async provisioning in Redis create tool description#2863
Open
vcolin7 wants to merge 2 commits into
Open
Clarify async provisioning in Redis create tool description#2863vcolin7 wants to merge 2 commits into
vcolin7 wants to merge 2 commits into
Conversation
Azure Cache for Redis provisioning is asynchronous; the create command returns immediately while the resource is still being created. Update the command description, XML summary, and docs to instruct callers to poll provisioningState until 'Succeeded' before connecting. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
vcolin7
requested review from
a team,
philon-msft,
sharedferret and
xiangyan99
as code owners
vcolin7
requested review from
chidozieononiwu,
fanyang-mono,
msalaman,
vukelich,
wbreza and
xirzec
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the azmcp redis create tool’s user-facing description/documentation to clarify that Azure Managed Redis provisioning is asynchronous and the command returns before the resource is fully ready, helping callers avoid misinterpreting provisioning states as errors.
Changes:
- Expanded
ResourceCreateCommandXML<summary>andCommandMetadata.Descriptionto set expectations about asynchronous provisioning. - Updated the
azmcp redis createentry inservers/Azure.Mcp.Server/docs/azmcp-commands.mdto mention pollingprovisioningState. - Added a changelog entry under “Other Changes” describing the documentation clarification.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tools/Azure.Mcp.Tools.Redis/src/Commands/ResourceCreateCommand.cs | Updates tool metadata and XML summary to describe async provisioning and recommended polling behavior. |
| servers/Azure.Mcp.Server/docs/azmcp-commands.md | Updates the CLI docs comment for azmcp redis create to mention async behavior and polling. |
| servers/Azure.Mcp.Server/changelog-entries/vcolin7-redis-create-async-description.yaml | Adds a changelog entry describing the updated tool description. |
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?
This PR updates the
azmcp redis createtool description to correctly say that Azure Cache for Redis provisioning is asynchronous. Without this change, callers and AI agents that immediatelyGETor test connectivity see a provisioning state and may misread it as an error.GitHub issue number?
Fixes #459
Pre-merge Checklist
azmcp redis createtoolservers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentation (N/A - no README command list change required)README.mdchanges running the script./eng/scripts/Process-PackageReadMe.ps1(N/A)ToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test promptsconsolidated-tools.json(N/A - no name change)servers/Azure.Mcp.Server/docs/azmcp-commands.md./eng/scripts/Update-AzCommandsMetadata.ps1to update tool metadataservers/Azure.Mcp.Server/docs/e2eTestPrompts.md(N/A - no new prompts)Invoking Livetests
Copilot submitted PRs are not trustworthy by default. Users with
writeaccess 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.