Skip to content

Conversation

@joshfree
Copy link
Member

@joshfree joshfree commented Sep 25, 2025

What does this PR do?

Make the text shorter and simpler. Make it very clear you only need 1 install option. Remove emojis and HTML anchor tags and ampersand symbols to reduce pain for package pipeline infrastructure.

  • Simplified Custom Client (renamed to "Other IDEs")
  • Simplified install steps for Docker, Nuget, and NPM for consistency with the "Other IDEs" changes.
  • Fixed tab/spacing bugs with json and bash snippets
  • Removed emojis and HTML anchors
  • Removed & from headings as that is not recommended per style-guide

GitHub issue number?

N/A

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 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
    • Updated command list in /docs/azmcp-commands.md and/or /docs/fabric-commands.md
    • 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 /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

Improve install steps for Package Managers and Custom Clients
@joshfree joshfree requested a review from a team as a code owner September 25, 2025 18:28
@joshfree joshfree self-assigned this Sep 25, 2025
@joshfree joshfree moved this from Untriaged to In Progress in Azure MCP Server Sep 25, 2025
@joshfree joshfree added documentation Improvements or additions to documentation server-Azure.Mcp Azure.Mcp.Server labels Sep 25, 2025
@joshfree joshfree enabled auto-merge (squash) September 25, 2025 20:03
@joshfree joshfree mentioned this pull request Sep 25, 2025
Remove emojis simplify text
Copilot AI review requested due to automatic review settings September 25, 2025 21:32
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 improves the installation documentation for the Azure MCP Server by reorganizing and clarifying the installation methods. The changes focus on making it clearer how users can install and configure the Azure MCP Server across different environments.

Key changes include:

  • Reorganized installation sections to better distinguish IDEs from package managers
  • Added clearer instructions for unsupported IDEs under "Other IDEs" section
  • Simplified and standardized installation steps for Docker, NuGet, and NPM

@joshfree joshfree changed the title Improve install steps for Package Managers and Custom Clients Remove README Header emojis, simplify sections in preparation for Package Manager Readme Consolidation/Infra Sep 25, 2025
Updated formatting and improved clarity in README.
Updated README.md to correct headings and improve clarity in the installation section.
@joshfree joshfree merged commit 36ed249 into main Sep 25, 2025
22 checks passed
@joshfree joshfree deleted the joshfree-patch-1 branch September 25, 2025 23:08
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure MCP Server Sep 25, 2025
colbytimm pushed a commit to colbytimm/microsoft-mcp that referenced this pull request Sep 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation server-Azure.Mcp Azure.Mcp.Server

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants