Skip to content

Conversation

chidozieononiwu
Copy link
Member

What does this PR do?

  • Updates Pack-Nuget.ps1 so that it selects Azure or Microsoft Logo based on the MCP.Server PackageId
  • Adds a MERGED.md (will eventually become README.md)
  • The goal is to have one shared readme to which we can remove or insert content based on the target package type npm|nuget|vsix

GitHub issue number?

#475

@chidozieononiwu chidozieononiwu requested a review from a team as a code owner September 18, 2025 19:00
@Copilot Copilot AI review requested due to automatic review settings September 18, 2025 19:00
@chidozieononiwu chidozieononiwu requested a review from a team as a code owner September 18, 2025 19:00
Copy link
Contributor

@Copilot 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 implements context-specific README generation for different package types (npm, nuget, vsix) by introducing a unified template system with conditional content rendering based on the target package. It also updates the NuGet packaging script to dynamically select appropriate logos based on the package ID prefix.

  • Adds a comprehensive MERGED.md template with annotation-based content filtering
  • Creates a PowerShell script to process README templates and generate package-specific outputs
  • Updates NuGet packaging to use Microsoft or Azure logos based on package ID prefix

Reviewed Changes

Copilot reviewed 3 out of 6 changed files in this pull request and generated 5 comments.

File Description
servers/Azure.Mcp.Server/MERGED.md Master README template with conditional content annotations for different package types
eng/scripts/Process-PackageReadMe.ps1 PowerShell script to process template annotations and generate package-specific READMEs
eng/scripts/Pack-Nuget.ps1 Updated to dynamically select package icon based on PackageId prefix

@joshfree joshfree added this to the 2025-09 milestone Sep 19, 2025
@joshfree joshfree added the server-Azure.Mcp Azure.Mcp.Server label Sep 19, 2025
@joshfree joshfree moved this from Untriaged to In Progress in Azure MCP Server Sep 19, 2025
@chidozieononiwu chidozieononiwu force-pushed the ContextSpecificReadme branch 6 times, most recently from 93ab57e to 2af0aeb Compare September 20, 2025 00:42
@chidozieononiwu chidozieononiwu force-pushed the ContextSpecificReadme branch 7 times, most recently from 2838e16 to 95a86d5 Compare September 24, 2025 19:01
@g2vinay
Copy link
Contributor

g2vinay commented Sep 24, 2025

msedge_rQGYRTIqYD

The intro will read better with below text:

Seamlessly connect AI agents with Azure services directly from Visual Studio Code.

The Azure MCP Server extension implements the MCP specification, bringing all Azure MCP tools together in a single, unified server. Use it on its own or pair it with the GitHub Copilot for Azure extension to unlock richer AI-powered development experiences in supported IDEs.


Remove unneccessary whitespace below:
Further, pre-requisite section, isn't helpful here, can be removed.

image

Further, under Configuration section,
Recommending VS code or some other IDE is redundant here. It should just mention about installing the extension and then remove config section and move this under Installation section only.

msedge_kAgzXOazNa

Start to templatize Readme

Created Shared Readme

Add comment annotation to README.md to allow update at run time

Use Azure or Microsoft Icon

Updates to README.md

More readme updates

Use readme processing script at pack time

Remmove old README.md

Update Azure.Mco.Server README.md

Update README.md and ReadMe processing script

Remove spaces from Insert Payload

Add comments in Process-PackageReadMe script
@KarishmaGhiya KarishmaGhiya merged commit c2fce5b into microsoft:main Sep 25, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure MCP Server Sep 25, 2025
@joshfree
Copy link
Member

@weshaggard @hallipr @KarishmaGhiya @chidozieononiwu - this really complicated the README.md...

@joshfree
Copy link
Member

I wish we merged #578 before this. I think your formatting is about to need to be re-reviewed for each package

chidozieononiwu added a commit that referenced this pull request Sep 25, 2025
chidozieononiwu added a commit that referenced this pull request Sep 25, 2025
Revert "Context specific readme (#499)"

This reverts commit c2fce5b.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
server-Azure.Mcp Azure.Mcp.Server
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants