Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@KarishmaGhiya
Copy link
Member

What does this PR do?

Fixed npm readme inconsistencies
Fixes #777

GitHub issue number?

#777

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
    • 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
    • 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

@KarishmaGhiya KarishmaGhiya requested a review from a team as a code owner October 15, 2025 01:21
@joshfree joshfree moved this from Untriaged to In Progress in Azure MCP Server Oct 15, 2025
@joshfree joshfree added documentation Improvements or additions to documentation server-Azure.Mcp Azure.Mcp.Server labels Oct 15, 2025
@joshfree joshfree added this to the 2025-10 milestone Oct 15, 2025
Copilot AI review requested due to automatic review settings October 16, 2025 00:33
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

Clarifies and restructures the npm installation section of the Azure MCP Server README to resolve prior inconsistencies. Key updates focus on improving clarity around local vs global installation, npx usage, and adding troubleshooting and architecture references.

  • Adds explicit subsections for local install, version-specific install, and npx usage
  • Introduces guidance on when to choose local vs global installation plus troubleshooting and architecture links
  • Replaces a generic npx invocation placeholder with a concrete example

@KarishmaGhiya KarishmaGhiya merged commit a235370 into microsoft:main Oct 16, 2025
20 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure MCP Server Oct 16, 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.

NPM Readme section is inconsistent and doesn't look professional.

2 participants