From 4643d217a8cea505c8bb60f71f18a061f740401e Mon Sep 17 00:00:00 2001 From: "Sameeksha Vaity (from Dev Box)" Date: Wed, 10 Dec 2025 11:36:13 -0800 Subject: [PATCH 1/2] Update copilot instructions to include azure-sdk-mcp config info --- .github/copilot-instructions.md | 54 +++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0b5f79be156b..88d605bc634a 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -25,8 +25,62 @@ The Azure SDK for Java repository contains client libraries for Azure services, ### Prerequisites - To use Azure MCP tool calls, users must have PowerShell installed. Provide [PowerShell installation instructions](https://learn.microsoft.com/powershell/scripting/install/installing-powershell) if not installed, and recommend restarting the IDE to start the MCP server. +- See the next section for how to set up the Azure SDK MCP server in your IDE for advanced Copilot features. - Always run the [`azsdk_verify_setup`](../eng/common/instructions/azsdk-tools/verify-setup.instructions.md) tool to check the user's development environment setup for using SDK MCP tools. DO NOT PROCEED with running other tools before completing this step. Only skip for queries that don't need tools. +## Azure SDK MCP Server: Quick Start + +The Azure SDK MCP server enables advanced Copilot-powered automation, validation, and Azure-specific guidance in your IDE. + +| IDE | Config File Location | What to Do | +|----------|--------------------------------------|----------------------------------------------------------------------------| +| VSCode | `.vscode/mcp.json` | Add the JSON config below and restart VSCode | +| IntelliJ | `github-copilot/intellij/mcp.json` | Add the JSON config below and restart IntelliJ | + +### Configuration Example + +#### VSCode (`.vscode/mcp.json`) +```json +{ + "azure-sdk-mcp": { + "type": "stdio", + "command": "pwsh", + "args": [ + "${workspaceFolder}/eng/common/mcp/azure-sdk-mcp.ps1", + "-Run" + ] + } +} +``` + +#### IntelliJ (`github-copilot/intellij/mcp.json`) +```json +{ + "servers": { + "azure-sdk-mcp": { + "type": "stdio", + "command": "pwsh", + "args": [ + "${workspaceFolder}/eng/common/mcp/azure-sdk-mcp.ps1", + "-Run" + ] + } + } +} +``` + +- Make sure PowerShell is installed and available in your system PATH. +- Adjust the path to `azure-sdk-mcp.ps1` if your repository is structured differently. + +### Troubleshooting + +- If IntelliJ does not detect the MCP server, double-check the path and file name. +- Start the server manually with: + ```powershell + eng/common/mcp/azure-sdk-mcp.ps1 -Run + ``` +- For more help, see [eng/common/mcp/README.md](../eng/common/mcp/README.md) or open an issue. + ## Behavior - Always ensure your solutions prioritize clarity, maintainability, and testability. From 816b1da61ac652b9fe4fa69d820a8b3aa957e919 Mon Sep 17 00:00:00 2001 From: "Sameeksha Vaity (from Dev Box)" Date: Thu, 11 Dec 2025 11:12:46 -0800 Subject: [PATCH 2/2] review comments --- .github/copilot-instructions.md | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 88d605bc634a..a6ee33171963 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -32,27 +32,12 @@ The Azure SDK for Java repository contains client libraries for Azure services, The Azure SDK MCP server enables advanced Copilot-powered automation, validation, and Azure-specific guidance in your IDE. -| IDE | Config File Location | What to Do | -|----------|--------------------------------------|----------------------------------------------------------------------------| -| VSCode | `.vscode/mcp.json` | Add the JSON config below and restart VSCode | -| IntelliJ | `github-copilot/intellij/mcp.json` | Add the JSON config below and restart IntelliJ | +| IDE | Config File Location | What to Do | +|----------|------------------------------------|---------------------------| +| IntelliJ | `github-copilot/intellij/mcp.json` | Add the JSON config below | ### Configuration Example -#### VSCode (`.vscode/mcp.json`) -```json -{ - "azure-sdk-mcp": { - "type": "stdio", - "command": "pwsh", - "args": [ - "${workspaceFolder}/eng/common/mcp/azure-sdk-mcp.ps1", - "-Run" - ] - } -} -``` - #### IntelliJ (`github-copilot/intellij/mcp.json`) ```json { @@ -61,7 +46,7 @@ The Azure SDK MCP server enables advanced Copilot-powered automation, validation "type": "stdio", "command": "pwsh", "args": [ - "${workspaceFolder}/eng/common/mcp/azure-sdk-mcp.ps1", + "/eng/common/mcp/azure-sdk-mcp.ps1", "-Run" ] } @@ -70,7 +55,7 @@ The Azure SDK MCP server enables advanced Copilot-powered automation, validation ``` - Make sure PowerShell is installed and available in your system PATH. -- Adjust the path to `azure-sdk-mcp.ps1` if your repository is structured differently. +- Replace `` with the absolute path to your local clone of the Azure SDK for Java repository. ### Troubleshooting