Skip to content

Commit 4643d21

Browse files
committed
Update copilot instructions to include azure-sdk-mcp config info
1 parent 298fd62 commit 4643d21

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

.github/copilot-instructions.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,62 @@ The Azure SDK for Java repository contains client libraries for Azure services,
2525
### Prerequisites
2626

2727
- 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.
28+
- See the next section for how to set up the Azure SDK MCP server in your IDE for advanced Copilot features.
2829
- 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.
2930

31+
## Azure SDK MCP Server: Quick Start
32+
33+
The Azure SDK MCP server enables advanced Copilot-powered automation, validation, and Azure-specific guidance in your IDE.
34+
35+
| IDE | Config File Location | What to Do |
36+
|----------|--------------------------------------|----------------------------------------------------------------------------|
37+
| VSCode | `.vscode/mcp.json` | Add the JSON config below and restart VSCode |
38+
| IntelliJ | `github-copilot/intellij/mcp.json` | Add the JSON config below and restart IntelliJ |
39+
40+
### Configuration Example
41+
42+
#### VSCode (`.vscode/mcp.json`)
43+
```json
44+
{
45+
"azure-sdk-mcp": {
46+
"type": "stdio",
47+
"command": "pwsh",
48+
"args": [
49+
"${workspaceFolder}/eng/common/mcp/azure-sdk-mcp.ps1",
50+
"-Run"
51+
]
52+
}
53+
}
54+
```
55+
56+
#### IntelliJ (`github-copilot/intellij/mcp.json`)
57+
```json
58+
{
59+
"servers": {
60+
"azure-sdk-mcp": {
61+
"type": "stdio",
62+
"command": "pwsh",
63+
"args": [
64+
"${workspaceFolder}/eng/common/mcp/azure-sdk-mcp.ps1",
65+
"-Run"
66+
]
67+
}
68+
}
69+
}
70+
```
71+
72+
- Make sure PowerShell is installed and available in your system PATH.
73+
- Adjust the path to `azure-sdk-mcp.ps1` if your repository is structured differently.
74+
75+
### Troubleshooting
76+
77+
- If IntelliJ does not detect the MCP server, double-check the path and file name.
78+
- Start the server manually with:
79+
```powershell
80+
eng/common/mcp/azure-sdk-mcp.ps1 -Run
81+
```
82+
- For more help, see [eng/common/mcp/README.md](../eng/common/mcp/README.md) or open an issue.
83+
3084
## Behavior
3185

3286
- Always ensure your solutions prioritize clarity, maintainability, and testability.

0 commit comments

Comments
 (0)