Skip to content

Add installation GIF for Azure MCP Server extension in README (2nd attempt)#978

Merged
charris-msft merged 6 commits intomicrosoft:mainfrom
charris-msft:main
Oct 28, 2025
Merged

Add installation GIF for Azure MCP Server extension in README (2nd attempt)#978
charris-msft merged 6 commits intomicrosoft:mainfrom
charris-msft:main

Conversation

@charris-msft
Copy link
Copy Markdown
Contributor

What does this PR do?

Add installation GIF for Azure MCP Server extension in README

image

GitHub issue number?

#223

Pre-merge Checklist

  • [ x] Required for All PRs
    • [ x] Read contribution guidelines
    • [x ] PR title clearly describes the change
    • [x ] Commit history is clean with descriptive messages (cleanup guide)
    • Added comprehensive tests for new/modified functionality
    • Updated servers/Azure.Mcp.Server/CHANGELOG.md and/or servers/Fabric.Mcp.Server/CHANGELOG.md for product changes (features, bug fixes, UI/UX, updated dependencies)
  • 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 using script at eng/scripts/Process-PackageReadMe.ps1. See Package README
    • Updated command list in /servers/Azure.Mcp.Server/docs/azmcp-commands.md and/or /docs/fabric-commands.md
    • Run .\eng\scripts\Update-AzCommandsMetadata.ps1 to update tool metadata in azmcp-commands.md (required for CI)
    • 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 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 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

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 adds a visual installation guide by embedding a GIF that demonstrates how to install the Azure MCP Server extension in VS Code. The change enhances the documentation by providing a visual reference for users following the installation steps.

Key Changes

  • Added an animated GIF showing the Azure MCP Server extension installation process in the VS Code section of the README

Comment thread servers/Azure.Mcp.Server/README.md Outdated
Comment thread servers/Azure.Mcp.Server/README.md
Comment thread servers/Azure.Mcp.Server/README.md
@charris-msft charris-msft merged commit 82f73e1 into microsoft:main Oct 28, 2025
21 checks passed
@github-project-automation github-project-automation Bot moved this from Untriaged to Done in Azure MCP Server Oct 28, 2025
vcolin7 added a commit that referenced this pull request Oct 28, 2025
* Add instructions on when to not use azd init (#942)

* Add instrunctions on when to not use azd init

* Update CHANGELOG

* Address review feedback

* Refactored ToolDescriptionEvaluator code and added more options (#899)

* Renamed --validate to --test-single-tool

* Refactored Program.cs to remove duplicated tool loading logic

* Updated error message logic

* Refactored error handling and updated exceptions thrown

* Added new --server and --server-exe args and enhanced error handling for missing files and invalid arguments

* Updated docs

* Fixed syntax errors

* Removed azmcp_ prefix from e2eTestPrompts.md

* Fixed more issues

* Ran TDE

* Fixed parameter validation

* Updated more usre-facing messages

* Updated docs and --help command info

* Small doc update

* Removed file added by accident.

* Renamed header in README

* Applied some PR feedback

* Applied more PR feedback

* Updated logs

* Fixed formatting

* Merge release branch after `0.9.8` release (#948)

* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Adds ToolArea and ToolName to single mode telemetry. (#952)

* Make registry error message more descriptive.

* Set ToolArea and ToolName in single proxy mode.

* Update CHANGELOG.

* Apply suggestion from @Copilot

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

* Update CHANGELOG

---------

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

* Adding CELA approved warnings in README (#955)

* Adding CELA approved warnings

* Update servers/Azure.Mcp.Server/README.md

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

* removing localization in docs link

---------

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

* Updating ToC of Azure MCP readme (#968)

* Adding CELA approved warnings

* Update servers/Azure.Mcp.Server/README.md

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

* removing localization in docs link

* Updating ToC on Readme

---------

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

* Fix broken links in README (#979)

* Add installation GIF for Azure MCP Server extension in README (2nd attempt) (#978)

* Add installation GIF for Azure MCP Server extension in README

* Update servers/Azure.Mcp.Server/README.md

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

* Fix typo in remove-section markers in Azure.Mcp.Server README

---------

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

* Re-enable smoke tests (#981)

Enable smoke tests

* Prepare `1.0.0` release

* Fix README image reference and rename the gif (#983)

Add the install_azure_mcp_server_extension.gif asset and update README to reference the new filename (use underscores instead of dashes).

---------

Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sandeep Sen <sandeepsen@microsoft.com>
Co-authored-by: Vinay Gera <vigera@microsoft.com>
Co-authored-by: Chris Harris <charris@microsoft.com>
weshaggard added a commit that referenced this pull request Oct 29, 2025
* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Prepare version `0.9.9` release (#956)

* Add instructions on when to not use azd init (#942)

* Add instrunctions on when to not use azd init

* Update CHANGELOG

* Address review feedback

* Refactored ToolDescriptionEvaluator code and added more options (#899)

* Renamed --validate to --test-single-tool

* Refactored Program.cs to remove duplicated tool loading logic

* Updated error message logic

* Refactored error handling and updated exceptions thrown

* Added new --server and --server-exe args and enhanced error handling for missing files and invalid arguments

* Updated docs

* Fixed syntax errors

* Removed azmcp_ prefix from e2eTestPrompts.md

* Fixed more issues

* Ran TDE

* Fixed parameter validation

* Updated more usre-facing messages

* Updated docs and --help command info

* Small doc update

* Removed file added by accident.

* Renamed header in README

* Applied some PR feedback

* Applied more PR feedback

* Updated logs

* Fixed formatting

* Merge release branch after `0.9.8` release (#948)

* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Adds ToolArea and ToolName to single mode telemetry. (#952)

* Make registry error message more descriptive.

* Set ToolArea and ToolName in single proxy mode.

* Update CHANGELOG.

* Apply suggestion from @Copilot

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

* Update CHANGELOG

---------

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

* Updated CHANGELOGs for 0.9.9 release

---------

Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Increment version after release (#957)

Increment package version after release

* update README (#977)

* Prepare `1.0.0` release (#984)

* Add instructions on when to not use azd init (#942)

* Add instrunctions on when to not use azd init

* Update CHANGELOG

* Address review feedback

* Refactored ToolDescriptionEvaluator code and added more options (#899)

* Renamed --validate to --test-single-tool

* Refactored Program.cs to remove duplicated tool loading logic

* Updated error message logic

* Refactored error handling and updated exceptions thrown

* Added new --server and --server-exe args and enhanced error handling for missing files and invalid arguments

* Updated docs

* Fixed syntax errors

* Removed azmcp_ prefix from e2eTestPrompts.md

* Fixed more issues

* Ran TDE

* Fixed parameter validation

* Updated more usre-facing messages

* Updated docs and --help command info

* Small doc update

* Removed file added by accident.

* Renamed header in README

* Applied some PR feedback

* Applied more PR feedback

* Updated logs

* Fixed formatting

* Merge release branch after `0.9.8` release (#948)

* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Adds ToolArea and ToolName to single mode telemetry. (#952)

* Make registry error message more descriptive.

* Set ToolArea and ToolName in single proxy mode.

* Update CHANGELOG.

* Apply suggestion from @Copilot

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

* Update CHANGELOG

---------

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

* Adding CELA approved warnings in README (#955)

* Adding CELA approved warnings

* Update servers/Azure.Mcp.Server/README.md

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

* removing localization in docs link

---------

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

* Updating ToC of Azure MCP readme (#968)

* Adding CELA approved warnings

* Update servers/Azure.Mcp.Server/README.md

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

* removing localization in docs link

* Updating ToC on Readme

---------

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

* Fix broken links in README (#979)

* Add installation GIF for Azure MCP Server extension in README (2nd attempt) (#978)

* Add installation GIF for Azure MCP Server extension in README

* Update servers/Azure.Mcp.Server/README.md

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

* Fix typo in remove-section markers in Azure.Mcp.Server README

---------

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

* Re-enable smoke tests (#981)

Enable smoke tests

* Prepare `1.0.0` release

* Fix README image reference and rename the gif (#983)

Add the install_azure_mcp_server_extension.gif asset and update README to reference the new filename (use underscores instead of dashes).

---------

Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sandeep Sen <sandeepsen@microsoft.com>
Co-authored-by: Vinay Gera <vigera@microsoft.com>
Co-authored-by: Chris Harris <charris@microsoft.com>

* Fix NPM and NuGet smoke tests and updated VS Code plugin to NOT be a preview (#986)

* Fix NPM smoke test

* Fixed where NPM packages are looked up

* Changed the VS Code extension to not be marked as a preview

* Increment version after release (#988)

Increment package version after release

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Vinay Gera <vigera@microsoft.com>
Co-authored-by: Sandeep Sen <sandeepsen@microsoft.com>
Co-authored-by: Chris Harris <charris@microsoft.com>
colbytimm pushed a commit to colbytimm/microsoft-mcp that referenced this pull request Dec 8, 2025
…tempt) (microsoft#978)

* Add installation GIF for Azure MCP Server extension in README

* Update servers/Azure.Mcp.Server/README.md

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

* Fix typo in remove-section markers in Azure.Mcp.Server README

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
colbytimm pushed a commit to colbytimm/microsoft-mcp that referenced this pull request Dec 8, 2025
* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (microsoft#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Prepare version `0.9.9` release (microsoft#956)

* Add instructions on when to not use azd init (microsoft#942)

* Add instrunctions on when to not use azd init

* Update CHANGELOG

* Address review feedback

* Refactored ToolDescriptionEvaluator code and added more options (microsoft#899)

* Renamed --validate to --test-single-tool

* Refactored Program.cs to remove duplicated tool loading logic

* Updated error message logic

* Refactored error handling and updated exceptions thrown

* Added new --server and --server-exe args and enhanced error handling for missing files and invalid arguments

* Updated docs

* Fixed syntax errors

* Removed azmcp_ prefix from e2eTestPrompts.md

* Fixed more issues

* Ran TDE

* Fixed parameter validation

* Updated more usre-facing messages

* Updated docs and --help command info

* Small doc update

* Removed file added by accident.

* Renamed header in README

* Applied some PR feedback

* Applied more PR feedback

* Updated logs

* Fixed formatting

* Merge release branch after `0.9.8` release (microsoft#948)

* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (microsoft#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Adds ToolArea and ToolName to single mode telemetry. (microsoft#952)

* Make registry error message more descriptive.

* Set ToolArea and ToolName in single proxy mode.

* Update CHANGELOG.

* Apply suggestion from @Copilot

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

* Update CHANGELOG

---------

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

* Updated CHANGELOGs for 0.9.9 release

---------

Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Increment version after release (microsoft#957)

Increment package version after release

* update README (microsoft#977)

* Prepare `1.0.0` release (microsoft#984)

* Add instructions on when to not use azd init (microsoft#942)

* Add instrunctions on when to not use azd init

* Update CHANGELOG

* Address review feedback

* Refactored ToolDescriptionEvaluator code and added more options (microsoft#899)

* Renamed --validate to --test-single-tool

* Refactored Program.cs to remove duplicated tool loading logic

* Updated error message logic

* Refactored error handling and updated exceptions thrown

* Added new --server and --server-exe args and enhanced error handling for missing files and invalid arguments

* Updated docs

* Fixed syntax errors

* Removed azmcp_ prefix from e2eTestPrompts.md

* Fixed more issues

* Ran TDE

* Fixed parameter validation

* Updated more usre-facing messages

* Updated docs and --help command info

* Small doc update

* Removed file added by accident.

* Renamed header in README

* Applied some PR feedback

* Applied more PR feedback

* Updated logs

* Fixed formatting

* Merge release branch after `0.9.8` release (microsoft#948)

* Updated CHANGELOGs for 0.9.8 release

* Increment version after release (microsoft#946)

* Increment package version after release

* Add release branch to pull request pipeline

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

* Adds ToolArea and ToolName to single mode telemetry. (microsoft#952)

* Make registry error message more descriptive.

* Set ToolArea and ToolName in single proxy mode.

* Update CHANGELOG.

* Apply suggestion from @Copilot

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

* Update CHANGELOG

---------

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

* Adding CELA approved warnings in README (microsoft#955)

* Adding CELA approved warnings

* Update servers/Azure.Mcp.Server/README.md

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

* removing localization in docs link

---------

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

* Updating ToC of Azure MCP readme (microsoft#968)

* Adding CELA approved warnings

* Update servers/Azure.Mcp.Server/README.md

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

* removing localization in docs link

* Updating ToC on Readme

---------

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

* Fix broken links in README (microsoft#979)

* Add installation GIF for Azure MCP Server extension in README (2nd attempt) (microsoft#978)

* Add installation GIF for Azure MCP Server extension in README

* Update servers/Azure.Mcp.Server/README.md

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

* Fix typo in remove-section markers in Azure.Mcp.Server README

---------

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

* Re-enable smoke tests (microsoft#981)

Enable smoke tests

* Prepare `1.0.0` release

* Fix README image reference and rename the gif (microsoft#983)

Add the install_azure_mcp_server_extension.gif asset and update README to reference the new filename (use underscores instead of dashes).

---------

Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sandeep Sen <sandeepsen@microsoft.com>
Co-authored-by: Vinay Gera <vigera@microsoft.com>
Co-authored-by: Chris Harris <charris@microsoft.com>

* Fix NPM and NuGet smoke tests and updated VS Code plugin to NOT be a preview (microsoft#986)

* Fix NPM smoke test

* Fixed where NPM packages are looked up

* Changed the VS Code extension to not be marked as a preview

* Increment version after release (microsoft#988)

Increment package version after release

---------

Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Fan Yang <52458914+fanyang-mono@users.noreply.github.com>
Co-authored-by: Connie Yau <conniey@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Vinay Gera <vigera@microsoft.com>
Co-authored-by: Sandeep Sen <sandeepsen@microsoft.com>
Co-authored-by: Chris Harris <charris@microsoft.com>
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.

5 participants