Skip to content

Commit c785a02

Browse files
joshfreeCopilot
andauthored
Fix Docker instructions, Add Manual IDE Setup (#595)
* Fix Docker instructions, Add Manual IDE Setup Fix Docker instructions, Add Manual IDE Setup * Update servers/Azure.Mcp.Server/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Revise Docker run instructions in README.md Updated instructions for running the Azure MCP Server with Docker, replacing the bash command with a JSON configuration format. * tweak docker mcp.json root node tweak docker mcp.json root node * Fix formatting in README for MCP client setup Updated instructions for running MCP client with .env file. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent c2e6060 commit c785a02

File tree

1 file changed

+47
-30
lines changed

1 file changed

+47
-30
lines changed

servers/Azure.Mcp.Server/README.md

Lines changed: 47 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ All Azure MCP tools in a single server. The Azure MCP Server implements the [MCP
1212
- [VS Code (Recommended)](#vs-code-recommended)
1313
- [Visual Studio 2022](#visual-studio-2022)
1414
- [IntelliJ IDEA](#intellij-idea)
15-
- [Additional IDEs](#additional-ides)
15+
- [Manual Setup](#manual-setup)
1616
- [Package Manager](#package-manager)
1717
- [NuGet](#nuget)
1818
- [NPM](#npm)
@@ -26,7 +26,7 @@ All Azure MCP tools in a single server. The Azure MCP Server implements the [MCP
2626
- [Feedback and Support](#feedback-and-support)
2727
- [Security](#security)
2828
- [Data Collection](#data-collection)
29-
- [Contributing & Code of Conduct](#contributing)
29+
- [Contributing and Code of Conduct](#contributing)
3030

3131
# Overview
3232

@@ -62,41 +62,48 @@ From within Visual Studio 2022 install [GitHub Copilot for Azure (VS 2022)](http
6262
1. Install the [GitHub Copilot](https://plugins.jetbrains.com/plugin/17718-github-copilot) plugin.
6363
1. Install the [Azure Toolkit for Intellij](https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij) plugin.
6464

65-
### Additional IDEs
66-
67-
For IDEs not listed above, manually setup Azure MCP Server within the IDE.
65+
### Manual Setup
66+
Azure MCP Server can also be configured across other IDEs, CLIs, and MCP clients:
6867

6968
<details>
7069
<summary>Manual setup instructions</summary>
7170

72-
Configure via `mcp.json` (VS Code example - adapt structure for your IDE):
71+
#### Sample Configuration
7372

73+
Copy this configuration to your client's MCP configuration file:
7474
```json
75-
{
76-
"servers": {
77-
"Azure MCP Server": {
78-
"command": "npx",
79-
"args": [
75+
{
76+
"mcpServers": {
77+
"azure-mcp-server": {
78+
"command": "npx",
79+
"args": [
8080
"-y",
8181
"@azure/mcp@latest",
8282
"server",
8383
"start"
84-
]
84+
]
8585
}
86-
}
8786
}
87+
}
8888
```
89-
90-
In some environments you may need to run the server directly:
91-
92-
```bash
93-
npx -y @azure/mcp@latest server start
94-
```
95-
89+
**Note:** When manually configuring Visual Studio and Visual Studio Code, use `servers` instead of `mcpServers` as the root object.
90+
91+
**Client-Specific Configuration**
92+
| IDE | File Location | Documentation Link |
93+
|-----|---------------|-------------------|
94+
| **Amazon Q Developer** | `~/.aws/amazonq/mcp.json` (global)<br>`.amazonq/mcp.json` (workspace) | [AWS Q Developer MCP Guide](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/qdev-mcp.html) |
95+
| **Claude Code** | `~/.claude.json` or `.mcp.json` (project) | [Claude Code MCP Configuration](https://scottspence.com/posts/configuring-mcp-tools-in-claude-code) |
96+
| **Claude Desktop** | `~/.claude/claude_desktop_config.json` (macOS)<br>`%APPDATA%\Claude\claude_desktop_config.json` (Windows) | [Claude Desktop MCP Setup](https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop) |
97+
| **Cursor** | `~/.cursor/mcp.json` or `.cursor/mcp.json` | [Cursor MCP Documentation](https://docs.cursor.com/context/model-context-protocol) |
98+
| **IntelliJ IDEA** | Built-in MCP server (2025.2+)<br>Settings > Tools > MCP Server | [IntelliJ MCP Documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html) |
99+
| **Visual Studio** | `.mcp.json` (solution/workspace) | [Visual Studio MCP Setup](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022) |
100+
| **VS Code** | `.vscode/mcp.json` (workspace)<br>`settings.json` (user) | [VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) |
101+
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` | [Windsurf Cascade MCP Integration](https://docs.windsurf.com/windsurf/cascade/mcp) |
96102
</details>
97103

98104

99105
## Package Manager
106+
Package manager installation offers several advantages over IDE-specific setup, including centralized dependency management, CI/CD integration, support for headless/server environments, version control, and project portability.
100107

101108
Install Azure MCP Server via a package manager:
102109

@@ -118,40 +125,50 @@ npm install -g @azure/mcp
118125

119126
### Docker
120127

121-
Microsoft publishes an official Azure MCP Server Docker container on the [Microsoft Artifact Registry](https://mcr.microsoft.com/artifact/mar/azure-sdk/azure-mcp).
128+
Pull the Docker image: [mcr.microsoft.com/azure-sdk/azure-mcp](https://mcr.microsoft.com/artifact/mar/azure-sdk/azure-mcp).
129+
130+
```bash
131+
docker pull mcr.microsoft.com/azure-sdk/azure-mcp
132+
```
122133

123134
<details>
124-
<summary>Docker setup instructions</summary>
135+
<summary>Docker instructions</summary>
136+
137+
#### Create an env file with Azure credentials
125138

126139
1. Create a `.env` file with Azure credentials ([see EnvironmentCredential options](https://learn.microsoft.com/dotnet/api/azure.identity.environmentcredential)):
127140

128141
```bash
129-
AZURE_TENANT_ID={YOUR_AZURE_TENANT_ID}
130-
AZURE_CLIENT_ID={YOUR_AZURE_CLIENT_ID}
131-
AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
142+
AZURE_TENANT_ID={YOUR_AZURE_TENANT_ID}
143+
AZURE_CLIENT_ID={YOUR_AZURE_CLIENT_ID}
144+
AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
132145
```
133146

134-
2. Configure your MCP client with the Docker command:
147+
#### Configure your MCP client to use Docker:
148+
149+
2. Add or update existing `mcp.json`.
150+
- Replace `/full/path/to/your.env` with the actual `.env` file path.
151+
- Optionally, use `--env` or `--volume` to pass authentication values.
152+
- **Note:** When manually configuring Visual Studio and Visual Studio Code, use `servers` instead of `mcpServers` as the root object.
135153

136154
```json
137155
{
138-
"servers": {
156+
"mcpServers": {
139157
"Azure MCP Server": {
140158
"command": "docker",
141159
"args": [
142160
"run",
143161
"-i",
144162
"--rm",
145163
"--env-file",
146-
"/full/path/to/.env",
164+
"/full/path/to/your.env",
147165
"mcr.microsoft.com/azure-sdk/azure-mcp:latest"
148166
]
149167
}
150168
}
151169
}
152170
```
153-
154-
Replace `/full/path/to/.env` with your actual .env file path. Alternatively, use individual `--env` flags or `--volume` mounts for credentials.
171+
155172
</details>
156173

157174
# Usage

0 commit comments

Comments
 (0)