Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Conversation

@alzimmermsft
Copy link
Member

@alzimmermsft alzimmermsft commented Aug 19, 2025

What does this PR do?

Standardizes the Storage tools descriptions and option and parameter names.

Descriptions have dropped the inclusion of required and optional parameter information.

Option and parameter names have dropped name suffixes.

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
    • Updated CHANGELOG.md for product changes (features, bug fixes, UI/UX, updated dependencies)
    • Spelling check passes: .\eng\common\spelling\Invoke-Cspell.ps1
  • For MCP tool changes:
    • One tool per PR: This PR adds or modifies only one MCP tool for faster review cycles
    • Updated README.md documentation
    • Updated command list in /docs/azmcp-commands.md
    • Updated test prompts in /docs/e2eTestPrompts.md
    • For new or modified tool descriptions, ran the eng/tools/ToolDescriptionEvaluator tool and obtained a result >= 0.4
  • 👉 For Community (non-Azure 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 azure - mcp to run Live Test Pipeline

@alzimmermsft alzimmermsft marked this pull request as ready for review August 20, 2025 13:50
Copilot AI review requested due to automatic review settings August 20, 2025 13:50
@alzimmermsft alzimmermsft requested review from a team, jongio and xiangyan99 as code owners August 20, 2025 13:50
Copy link
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 standardizes Azure Storage tool descriptions and parameter names by removing redundant parameter documentation from descriptions and dropping name suffixes from option and parameter names for consistency.

  • Simplified tool descriptions by removing required/optional parameter lists
  • Renamed parameters to drop name suffixes (e.g., account-nameaccount, blob-namesblobs)
  • Updated test files to use the new parameter names consistently

Reviewed Changes

Copilot reviewed 42 out of 42 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/azmcp-commands.md Updated command examples to use new parameter names (account-nameaccount, blob-namesblobs)
Multiple test files Updated test variable names and parameter usage to match new naming conventions
StorageService.cs Renamed method parameters to drop name suffixes and use consistent naming
IStorageService.cs Updated interface method signatures to match service implementation
StorageOptionDefinitions.cs Renamed option constants and definitions to use consistent naming without name suffixes
Various Options classes Updated property names and JSON property mappings to use new naming scheme
QueueMessageSendResult.cs Converted to primary constructor and renamed messageContent to message
Various Command classes Updated to use new option names and removed parameter documentation from descriptions
StorageJsonContext.cs Reordered and added missing JSON serialization attributes

@github-project-automation github-project-automation bot moved this from Untriaged to In Progress in Azure MCP Server (OLD) Aug 20, 2025
@alzimmermsft alzimmermsft enabled auto-merge (squash) August 20, 2025 15:59
@alzimmermsft alzimmermsft merged commit 890dcda into Azure:main Aug 20, 2025
26 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure MCP Server (OLD) Aug 20, 2025
@alzimmermsft alzimmermsft deleted the StorageStandardize branch August 20, 2025 16:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants