Skip to content

Update copilot instructions to include azure-sdk-mcp config info #47535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samvaity merged 3 commits into from
Dec 17, 2025
+40 −1
Merged

Update copilot instructions to include azure-sdk-mcp config info #47535

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4643d21
Update copilot instructions to include azure-sdk-mcp config info
samvaity Dec 10, 2025
816b1da
review comments
samvaity Dec 11, 2025
890c801
Merge branch 'main' into mcp-intellij
samvaity Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,50 @@ 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.
- When using Copilot from Visual Studio or VS Code (not applicable when using Coding Agent on Github.com):
- See the next section for how to set up the Azure SDK MCP server in your IDE for advanced Copilot features.
- When using Copilot from IntelliJ, Visual Studio, VS Code (not applicable when using Coding Agent on Github.com):
- **Always run** the [`azsdk_verify_setup`](../eng/common/instructions/azsdk-tools/verify-setup.instructions.md) tool first to validate the user's development environment for SDK MCP tools.
- **Do not proceed** with any other tool execution until this step is complete.
- **Skip this check only** for queries that do not require tool execution.

## 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 |
|----------|------------------------------------|---------------------------|
| IntelliJ | `github-copilot/intellij/mcp.json` | Add the JSON config below |

### Configuration Example

#### IntelliJ (`github-copilot/intellij/mcp.json`)
```json
{
"servers": {
"azure-sdk-mcp": {
"type": "stdio",
"command": "pwsh",
"args": [
"<Path to azure-sdk-for-java repo>/eng/common/mcp/azure-sdk-mcp.ps1",
"-Run"
]
}
}
}
```

- Make sure PowerShell is installed and available in your system PATH.
- Replace `<Path to azure-sdk-for-java repo>` with the absolute path to your local clone of the Azure SDK for Java repository.

### 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.
Expand Down