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

Conversation

@fanyang-mono
Copy link
Contributor

@fanyang-mono fanyang-mono commented Aug 19, 2025

What does this PR do?

Provide azure best practices via server instructions. Any clients who honor MCP instructions will get instruction on when to call our bestpractices tools.

For VS Code Copilot agent mode, I've seen these instructions being added to the system prompt
Screenshot 2025-08-19 at 4 21 35 PM

GitHub issue number?

289

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

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 adds Azure best practices content to the server instructions that are provided to LLMs when they interact with the Azure MCP Server. The implementation embeds Azure best practices guidance directly into the server instructions to improve the quality of LLM interactions.

Key changes:

  • Added comprehensive server instructions generation with embedded Azure best practices content
  • Modified the BestPracticesCommand to load resources from the core assembly for consistency
  • Added unit tests to verify the server instructions configuration

Reviewed Changes

Copilot reviewed 4 out of 9 changed files in this pull request and generated 4 comments.

File Description
ServiceCollectionExtensions.cs Added GetServerInstructions() method that generates comprehensive instructions including Azure best practices from embedded resources
ServiceCollectionExtensionsTests.cs Added unit test to verify server instructions are properly configured with expected content
BestPracticesCommand.cs Modified to load embedded resources from the core assembly instead of local assembly
CHANGELOG.md Added entry documenting the new feature

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

@joshfree joshfree moved this from Untriaged to In Progress in Azure MCP Server (OLD) Aug 19, 2025
@fanyang-mono fanyang-mono enabled auto-merge (squash) August 19, 2025 20:34
@fanyang-mono fanyang-mono merged commit 379b557 into Azure:main Aug 19, 2025
26 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure MCP Server (OLD) Aug 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants