@azure/mcp 0.2.0 โ 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +125 -101
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,24 +1,51 @@
|
|
|
1
1
|
# ๐ Azure MCP Server
|
|
2
2
|
|
|
3
|
+
The Azure MCP Server implements the [MCP specification](https://modelcontextprotocol.io) to create a seamless connection between AI agents and Azure services. Azure MCP Server can be used alone or with the [GitHub Copilot for Azure extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) in VS Code. This project is in Public Preview and implementation may significantly change prior to our General Availability.
|
|
3
4
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
The Azure MCP Server implements the [MCP specification](https://modelcontextprotocol.io) to create a seamless connection between AI agents and key Azure services like Azure Storage, Cosmos DB, and more.
|
|
7
|
-
|
|
8
|
-
> Please note that this project is in Public Preview and implementation may significantly change prior to our General Availability.
|
|
9
|
-
|
|
10
|
-
## ๐ Table of contents
|
|
11
|
-
1. [๐ฏ Overview](#-overview)
|
|
12
|
-
2. [๐ ๏ธ Currently Supported Tools](#%EF%B8%8F-currently-supported-tools)
|
|
13
|
-
3. [๐ Installation & Getting Started](#-getting-started)
|
|
14
|
-
4. [๐งช Using Azure MCP Server](#-test-the-azure-mcp-server)
|
|
15
|
-
5. [๐ Troubleshooting Issues](#-troubleshooting)
|
|
16
|
-
6. [๐ฅ Contributing to Azure MCP Server](#-contributing)
|
|
17
|
-
|
|
5
|
+
Here's a short (16 seconds) video to help you get the Azure MCP Server installed in VS Code.
|
|
6
|
+
<video src="https://github.com/user-attachments/assets/535f393c-0ed2-479d-9b24-5ca933293c92" width="1080" height="1920" controls></video>
|
|
18
7
|
|
|
19
|
-
|
|
8
|
+
### โ๏ธ VS Code Install Steps (Recommended)
|
|
9
|
+
1. Install either the stable or Insiders release of VS Code:
|
|
10
|
+
* [๐ซ Stable release](https://code.visualstudio.com/download)
|
|
11
|
+
* [๐ฎ Insiders release](https://code.visualstudio.com/insiders)
|
|
12
|
+
2. Install the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) and [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extensions
|
|
13
|
+
3. Install [Node.js](https://nodejs.org/en/download) 20 or later
|
|
14
|
+
* Ensure `node` and `npm` are in your path
|
|
15
|
+
4. Open VS Code in an empty folder
|
|
16
|
+
5. Install any of the available Azure MCP Server(s) for either the stable or Insiders release of VS Code
|
|
17
|
+
6. Open GitHub Copilot in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode)
|
|
18
|
+
7. Click `refresh` on the tools list.
|
|
19
|
+
|
|
20
|
+
#### ๐ค Available Azure MCP Servers
|
|
21
|
+
|
|
22
|
+
| Name | Description | VS Code | VS Code Insiders |
|
|
23
|
+
|--------------|-----------------------------------------------------------------------------------------------|---------|------------------|
|
|
24
|
+
| All | All Azure tools in a single MCP server | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%5D%7D&quality=insiders) |
|
|
25
|
+
| App Configuration | App Configuration operations - Manage App Configuration stores. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20App%20Config&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22appconfig%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20App%20Config&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22appconfig%22%5D%7D&quality=insiders) |
|
|
26
|
+
| Best Practices | Returns secure, production-grade Azure SDK best practices. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Best%20Practices&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22bestpractices%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Best%20Practices&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22bestpractices%22%5D%7D&quality=insiders) |
|
|
27
|
+
| Cosmos DB | Cosmos DB operations - Manage/query Cosmos DB resources. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Cosmos&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22cosmos%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Cosmos&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22cosmos%22%5D%7D&quality=insiders) |
|
|
28
|
+
| Key Vault | Key Vault operations - Manage/access Azure Key Vault resources. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Key%20Vault&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22keyvault%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Key%20Vault&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22keyvault%22%5D%7D&quality=insiders) |
|
|
29
|
+
| Kusto | Kusto operations - Manage/query Azure Data Explorer clusters. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Kusto&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22kusto%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Kusto&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22kusto%22%5D%7D&quality=insiders) |
|
|
30
|
+
| Monitor | Azure Monitor operations - Query/analyze logs and metrics. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Monitor&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22monitor%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Monitor&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22monitor%22%5D%7D&quality=insiders) |
|
|
31
|
+
| PostgreSQL | PostgreSQL operations - Manage Azure Database for PostgreSQL - Flexible server. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20PostgreSQL&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22postgres%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20PostgreSQL&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22postgres%22%5D%7D&quality=insiders) |
|
|
32
|
+
| Redis Cache | Redis Cache operations - Manage/access Azure Redis Cache resources. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Redis%20Cache&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22redis%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Redis%20Cache&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22redis%22%5D%7D&quality=insiders) |
|
|
33
|
+
| Resource Group | Resource group operations - List/manage Azure resource groups. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Resource%20Group&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22group%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Resource%20Group&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22group%22%5D%7D&quality=insiders) |
|
|
34
|
+
| Search | Search operations - Manage/list Azure AI Search services. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Search&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22search%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Search&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22search%22%5D%7D&quality=insiders) |
|
|
35
|
+
| Service Bus | Service Bus operations - Manage Azure Service Bus resources. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Service%20Bus&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22servicebus%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Service%20Bus&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22servicebus%22%5D%7D&quality=insiders) |
|
|
36
|
+
| Storage | Storage operations - Manage/access Azure Storage resources. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Storage&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22storage%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Storage&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22storage%22%5D%7D&quality=insiders) |
|
|
37
|
+
| Subscription | Azure subscription operations - List/manage Azure subscriptions. | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Subscription&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22subscription%22%5D%7D) | [](https://insiders.vscode.dev/redirect/mcp/install?name=Azure%20Subscription&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22@azure%2Fmcp%40latest%22%2C%22server%22%2C%22start%22%2C%22--service%22%2C%22subscription%22%5D%7D&quality=insiders) |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### โถ๏ธ Getting Started
|
|
42
|
+
1. Open GitHub Copilot in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode)
|
|
43
|
+
2. You should see the Azure MCP Server in the list of tools
|
|
44
|
+
3. Try a prompt that tells the agent to use the Azure MCP Server, such as "List my Azure Storage containers"
|
|
45
|
+
4. The agent should be able to use the Azure MCP Server tools to complete your query
|
|
46
|
+
5. For help with common issues see [Troubleshooting guide](https://github.com/Azure/azure-mcp/blob/main/TROUBLESHOOTING.md)
|
|
20
47
|
|
|
21
|
-
|
|
48
|
+
## โจ What can you do with the Azure MCP Server?
|
|
22
49
|
|
|
23
50
|
The Azure MCP Server supercharges your agents with Azure context. Here are some cool prompts you can try:
|
|
24
51
|
|
|
@@ -48,18 +75,10 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
|
|
|
48
75
|
- "List my Azure CDN endpoints"
|
|
49
76
|
- "Help me build an Azure application using Node.js"
|
|
50
77
|
|
|
51
|
-
### ๐ How It Works
|
|
52
|
-
|
|
53
|
-
The Azure MCP Server creates a seamless integration between AI agents and Azure services through:
|
|
54
|
-
|
|
55
|
-
- ๐ Smart JSON communication that AI agents understand
|
|
56
|
-
- ๐๏ธ Natural language commands that get translated to Azure operations
|
|
57
|
-
- ๐ก Intelligent parameter suggestions and auto-completion
|
|
58
|
-
- โก Consistent error handling that makes sense
|
|
59
78
|
|
|
60
79
|
## ๐ ๏ธ Currently Supported Tools
|
|
61
|
-
|
|
62
|
-
The Azure MCP Server provides tools for interacting with the following Azure services
|
|
80
|
+
<details>
|
|
81
|
+
<summary>The Azure MCP Server provides tools for interacting with the following Azure services</summary>
|
|
63
82
|
|
|
64
83
|
### ๐ Azure AI Search (search engine/vector database)
|
|
65
84
|
- List Azure AI Search services
|
|
@@ -91,7 +110,7 @@ The Azure MCP Server provides tools for interacting with the following Azure ser
|
|
|
91
110
|
- List and query Storage tables
|
|
92
111
|
- Get container properties and metadata
|
|
93
112
|
|
|
94
|
-
### ๐ Azure Monitor
|
|
113
|
+
### ๐ Azure Monitor
|
|
95
114
|
#### Log Analytics
|
|
96
115
|
- List Log Analytics workspaces
|
|
97
116
|
- Query logs using KQL
|
|
@@ -109,12 +128,18 @@ The Azure MCP Server provides tools for interacting with the following Azure ser
|
|
|
109
128
|
### ๐ Azure Key Vault
|
|
110
129
|
- List, create, and get keys
|
|
111
130
|
|
|
131
|
+
### ๐ญ Azure Role-Based Access Control (RBAC)
|
|
132
|
+
- List role assignments
|
|
133
|
+
|
|
112
134
|
### ๐ฆ Azure Resource Groups
|
|
113
135
|
- List resource groups
|
|
114
136
|
|
|
115
137
|
### ๐ Azure Service Bus
|
|
116
138
|
- Examine properties and runtime information about queues, topics, and subscriptions
|
|
117
139
|
|
|
140
|
+
### โ๏ธ Azure Native ISV Services
|
|
141
|
+
- List Monitored Resources in a Datadog Monitor
|
|
142
|
+
|
|
118
143
|
### ๐ง Azure CLI Extension
|
|
119
144
|
- Execute Azure CLI commands directly
|
|
120
145
|
- Support for all Azure CLI functionality
|
|
@@ -130,46 +155,72 @@ Agents and models can discover and learn best practices and usage guidelines for
|
|
|
130
155
|
|
|
131
156
|
### ๐ก๏ธ Azure Best Practices
|
|
132
157
|
- Get secure, production-grade Azure SDK best practices for effective code generation.
|
|
158
|
+
</details>
|
|
133
159
|
|
|
134
160
|
For detailed command documentation and examples, see [Azure MCP Commands](https://github.com/Azure/azure-mcp/blob/main/docs/azmcp-commands.md).
|
|
135
161
|
|
|
136
|
-
##
|
|
162
|
+
## ๐๏ธ Upgrading Existing Installs to the Latest Version
|
|
137
163
|
|
|
138
|
-
|
|
164
|
+
<details>
|
|
165
|
+
<summary>How to stay current with releases of Azure MCP Server</summary>
|
|
139
166
|
|
|
140
|
-
|
|
167
|
+
#### NPX
|
|
141
168
|
|
|
142
|
-
|
|
169
|
+
If you use the default package spec of `@azure/mcp@latest`, npx will look for a new version on each server start. If you use just `@azure/mcp`, npx will continue to use its cached version until its cache is cleared.
|
|
143
170
|
|
|
144
|
-
|
|
145
|
-
1. Install either the stable or Insiders release of VS Code:
|
|
146
|
-
* [๐ซ Stable release](https://code.visualstudio.com/download)
|
|
147
|
-
* [๐ฎ Insiders release](https://code.visualstudio.com/insiders)
|
|
148
|
-
2. Install the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) and [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extensions
|
|
149
|
-
3. Install [Node.js](https://nodejs.org/en/download) 20 or later
|
|
150
|
-
* Ensure `node` and `npm` are in your path
|
|
151
|
-
4. Open VS Code in an empty folder
|
|
171
|
+
#### NPM
|
|
152
172
|
|
|
153
|
-
|
|
173
|
+
If you globally install the cli via `npm install -g @azure/mcp` it will use the installed version until you manually update it with `npm update -g @azure/mcp`.
|
|
154
174
|
|
|
155
|
-
####
|
|
175
|
+
#### Docker
|
|
156
176
|
|
|
157
|
-
|
|
177
|
+
There is no version update built into the docker image. To update, just pull the latest from the repo and repeat the [docker installation instructions](#docker-install).
|
|
158
178
|
|
|
159
|
-
|
|
179
|
+
#### VS Code
|
|
160
180
|
|
|
161
|
-
|
|
181
|
+
Installation in VS Code should be in one of the previous forms and the update instructions are the same. If you installed the mcp server with the `npx` command and `-y @azure/mcp@latest` args, npx will check for package updates each time VS Code starts the server. Using a docker container in VS Code has the same no-update limitation described above.
|
|
182
|
+
</details>
|
|
162
183
|
|
|
163
|
-
|
|
184
|
+
## โ๏ธ Advanced Install Scenarios (Optional)
|
|
185
|
+
<details>
|
|
186
|
+
<summary>Docker containers, custom MCP clients, and manual install options</summary>
|
|
164
187
|
|
|
165
|
-
|
|
188
|
+
#### ๐ Docker Install Steps (Optional)
|
|
189
|
+
For a step-by-step Docker installation, follow these instructions:
|
|
166
190
|
|
|
167
|
-
|
|
191
|
+
1. Clone repository
|
|
192
|
+
2. From repository root, build Docker image: `docker build -t azure/azuremcp .`
|
|
193
|
+
3. Create an `.env` file with environment variables that [match one of the `EnvironmentCredential`](https://learn.microsoft.com/dotnet/api/azure.identity.environmentcredential) sets. For example, a `.env` file using a service principal could look like:
|
|
194
|
+
```json
|
|
195
|
+
AZURE_TENANT_ID={YOUR_AZURE_TENANT_ID}
|
|
196
|
+
AZURE_CLIENT_ID={YOUR_AZURE_CLIENT_ID}
|
|
197
|
+
AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
|
|
198
|
+
```
|
|
199
|
+
4. Add `.vscode/mcp.json` or update existing MCP configuration. Replace `/full/path/to/.env` with a path to your `.env` file.
|
|
200
|
+
```json
|
|
201
|
+
{
|
|
202
|
+
"servers": {
|
|
203
|
+
"Azure MCP Server": {
|
|
204
|
+
"command": "docker",
|
|
205
|
+
"args": [
|
|
206
|
+
"run",
|
|
207
|
+
"-i",
|
|
208
|
+
"--rm",
|
|
209
|
+
"--env-file",
|
|
210
|
+
"/full/path/to/.env"
|
|
211
|
+
"azure/azuremcp",
|
|
212
|
+
]
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
```
|
|
168
217
|
|
|
169
|
-
|
|
218
|
+
Optionally, customers can use `--env` or `--volume` to pass authentication values.
|
|
170
219
|
|
|
171
|
-
####
|
|
220
|
+
#### ๐ค Custom MCP Client Install Steps (Optional)
|
|
221
|
+
You can easily configure your MCP client to use the Azure MCP Server. Have your client run the following command and access it via standard IO or SSE.
|
|
172
222
|
|
|
223
|
+
#### ๐ง Manual Install Steps (Optional)
|
|
173
224
|
For a step-by-step installation, follow these instructions:
|
|
174
225
|
|
|
175
226
|
1. Add `.vscode/mcp.json`:
|
|
@@ -189,67 +240,27 @@ For a step-by-step installation, follow these instructions:
|
|
|
189
240
|
}
|
|
190
241
|
```
|
|
191
242
|
|
|
192
|
-
|
|
243
|
+
You can optionally set the `--service <service>` flag to install tools for the specified Azure product or service.
|
|
193
244
|
|
|
194
|
-
|
|
195
|
-
1. Clone repository
|
|
196
|
-
2. From repository root, build Docker image: `docker build -t azure/azuremcp .`
|
|
197
|
-
3. Create an `.env` file with environment variables that [match one of the `EnvironmentCredential`](https://learn.microsoft.com/dotnet/api/azure.identity.environmentcredential) sets. For example, a `.env` file using a service principal could look like:
|
|
198
|
-
```json
|
|
199
|
-
AZURE_TENANT_ID={YOUR_AZURE_TENANT_ID}
|
|
200
|
-
AZURE_CLIENT_ID={YOUR_AZURE_CLIENT_ID}
|
|
201
|
-
AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
|
|
202
|
-
```
|
|
203
|
-
1. Add `.vscode/mcp.json` or update existing MCP configuration. Replace `/full/path/to/.env` with a path to your `.env` file.
|
|
245
|
+
1. Add `.vscode/mcp.json`:
|
|
204
246
|
```json
|
|
205
247
|
{
|
|
206
248
|
"servers": {
|
|
207
|
-
"Azure
|
|
208
|
-
"command": "
|
|
249
|
+
"Azure Best Practices": {
|
|
250
|
+
"command": "npx",
|
|
209
251
|
"args": [
|
|
210
|
-
"
|
|
211
|
-
"
|
|
212
|
-
"
|
|
213
|
-
"
|
|
214
|
-
"--
|
|
215
|
-
"
|
|
252
|
+
"-y",
|
|
253
|
+
"@azure/mcp@latest",
|
|
254
|
+
"server",
|
|
255
|
+
"start",
|
|
256
|
+
"--service",
|
|
257
|
+
"bestpractices" // Any of the available MCP servers can be referenced here.
|
|
216
258
|
]
|
|
217
259
|
}
|
|
218
260
|
}
|
|
219
261
|
}
|
|
220
262
|
```
|
|
221
263
|
|
|
222
|
-
Optionally, customers can use `--env` or `--volume` to pass authentication values.
|
|
223
|
-
|
|
224
|
-
### ๐๏ธ Updates
|
|
225
|
-
|
|
226
|
-
#### NPX
|
|
227
|
-
|
|
228
|
-
If you use the default package spec of `@azure/mcp@latest`, npx will look for a new version on each server start. If you use just `@azure/mcp`, npx will continue to use its cached version until its cache is cleared.
|
|
229
|
-
|
|
230
|
-
#### NPM
|
|
231
|
-
|
|
232
|
-
If you globally install the cli via `npm install -g @azure/mcp` it will use the installed version until you manually update it with `npm update -g @azure/mcp`.
|
|
233
|
-
|
|
234
|
-
#### Docker
|
|
235
|
-
|
|
236
|
-
There is no version update built into the docker image. To update, just pull the latest from the repo and repeat the [docker installation instructions](#docker-install).
|
|
237
|
-
|
|
238
|
-
#### VS Code
|
|
239
|
-
|
|
240
|
-
Installation in VS Code should be in one of the previous forms and the update instructions are the same. If you installed the mcp server with the `npx` command and `-y @azure/mcp@latest` args, npx will check for package updates each time VS Code starts the server. Using a docker container in VS Code has the same no-update limitation described above.
|
|
241
|
-
|
|
242
|
-
## ๐งช Test the Azure MCP Server
|
|
243
|
-
|
|
244
|
-
1. Open GitHub Copilot in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode)
|
|
245
|
-
2. You should see the Azure MCP Server in the list of tools
|
|
246
|
-
3. Try a prompt that tells the agent to use the Azure MCP Server, such as "List my Azure Storage containers"
|
|
247
|
-
4. The agent should be able to use the Azure MCP Server tools to complete your query
|
|
248
|
-
|
|
249
|
-
## ๐ค Custom MCP Clients
|
|
250
|
-
|
|
251
|
-
You can easily configure your MCP client to use the Azure MCP Server. Have your client run the following command and access it via standard IO or SSE.
|
|
252
|
-
|
|
253
264
|
### Using standard IO
|
|
254
265
|
|
|
255
266
|
Configure the MCP client to execute: `npx -y @azure/mcp@latest server start`. For instructions on using , follow instructions in [Quick install with VS Code](#-quick-install-with-vs-code) or [Manual Install](#-manual-install).
|
|
@@ -272,12 +283,17 @@ Configure the MCP client to execute: `npx -y @azure/mcp@latest server start`. Fo
|
|
|
272
283
|
|
|
273
284
|
|
|
274
285
|
More end-to-end MCP client/agent guides are coming soon!
|
|
286
|
+
</details>
|
|
287
|
+
|
|
275
288
|
|
|
276
289
|
## ๐ Troubleshooting
|
|
277
290
|
|
|
278
291
|
See [Troubleshooting guide](https://github.com/Azure/azure-mcp/blob/main/TROUBLESHOOTING.md) for help with common issues and logging.
|
|
279
292
|
|
|
280
|
-
|
|
293
|
+
### ๐ Authentication
|
|
294
|
+
|
|
295
|
+
<details>
|
|
296
|
+
<summary>Authentication options including DefaultAzureCredential flow, RBAC permissions, troubleshooting, and production credentials</summary>
|
|
281
297
|
|
|
282
298
|
The Azure MCP Server seamlessly integrates with your host operating system's authentication mechanisms, making it super easy to get started! We use Azure Identity under the hood via [`DefaultAzureCredential`](https://learn.microsoft.com/dotnet/azure/sdk/authentication/credential-chains?tabs=dac), which tries these credentials in order:
|
|
283
299
|
|
|
@@ -293,6 +309,8 @@ If you're already logged in through any of these methods, the Azure MCP Server w
|
|
|
293
309
|
|
|
294
310
|
If you're running into any issues with authentication, visit our [troubleshooting guide](https://github.com/Azure/azure-mcp/blob/main/TROUBLESHOOTING.md).
|
|
295
311
|
|
|
312
|
+
For enterprise authentication scenarios including network restrictions, security policies, and protected resources, see our [Authentication and Security guide](https://github.com/Azure/azure-mcp/blob/main/docs/Authentication.md).
|
|
313
|
+
|
|
296
314
|
### Production Credentials
|
|
297
315
|
|
|
298
316
|
By default, the Azure MCP Server excludes production credentials like Managed Identity and Workload Identity. To enable these credentials, set the environment variable:
|
|
@@ -302,6 +320,7 @@ AZURE_MCP_INCLUDE_PRODUCTION_CREDENTIALS=true
|
|
|
302
320
|
```
|
|
303
321
|
|
|
304
322
|
This is useful when running on Azure services where you want to use managed identities.
|
|
323
|
+
</details>
|
|
305
324
|
|
|
306
325
|
## ๐ก๏ธ Security Note
|
|
307
326
|
|
|
@@ -310,7 +329,6 @@ Your credentials are always handled securely through the official [Azure Identit
|
|
|
310
329
|
MCP as a phenomenon is very novel and cutting-edge. As with all new technology standards, consider doing a security review to ensure any systems that integrate with MCP servers follow all regulations and standards your system is expected to adhere to. This includes not only the Azure MCP Server, but any MCP client/agent that you choose to implement down to the model provider.
|
|
311
330
|
|
|
312
331
|
## ๐ฅ Contributing
|
|
313
|
-
|
|
314
332
|
We welcome contributions to the Azure MCP Server! Whether you're fixing bugs, adding new features, or improving documentation, your contributions are welcome.
|
|
315
333
|
|
|
316
334
|
Please read our [Contributing Guide](https://github.com/Azure/azure-mcp/blob/main/CONTRIBUTING.md) for guidelines on:
|
|
@@ -320,6 +338,12 @@ Please read our [Contributing Guide](https://github.com/Azure/azure-mcp/blob/mai
|
|
|
320
338
|
- ๐ Code style and testing requirements
|
|
321
339
|
- ๐ Making pull requests
|
|
322
340
|
|
|
341
|
+
## ๐ฌ Feedback
|
|
342
|
+
|
|
343
|
+
We're building this in the open. Your feedback is much appreciated, and will help us shape the future of the Azure MCP server.
|
|
344
|
+
|
|
345
|
+
๐ [Open an issue in the public repository](https://github.com/Azure/azure-mcp/issues/new/choose).
|
|
346
|
+
|
|
323
347
|
## ๐ค Code of Conduct
|
|
324
348
|
|
|
325
349
|
This project has adopted the
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure/mcp",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Azure MCP Server - Model Context Protocol implementation for Azure",
|
|
5
5
|
"author": "Microsoft Corporation",
|
|
6
6
|
"homepage": "https://github.com/Azure/azure-mcp#readme",
|
|
@@ -33,11 +33,11 @@
|
|
|
33
33
|
"arm64"
|
|
34
34
|
],
|
|
35
35
|
"optionalDependencies": {
|
|
36
|
-
"@azure/mcp-darwin-x64": "0.2.
|
|
37
|
-
"@azure/mcp-linux-arm64": "0.2.
|
|
38
|
-
"@azure/mcp-darwin-arm64": "0.2.
|
|
39
|
-
"@azure/mcp-win32-x64": "0.2.
|
|
40
|
-
"@azure/mcp-linux-x64": "0.2.
|
|
41
|
-
"@azure/mcp-win32-arm64": "0.2.
|
|
36
|
+
"@azure/mcp-darwin-x64": "0.2.2",
|
|
37
|
+
"@azure/mcp-linux-arm64": "0.2.2",
|
|
38
|
+
"@azure/mcp-darwin-arm64": "0.2.2",
|
|
39
|
+
"@azure/mcp-win32-x64": "0.2.2",
|
|
40
|
+
"@azure/mcp-linux-x64": "0.2.2",
|
|
41
|
+
"@azure/mcp-win32-arm64": "0.2.2"
|
|
42
42
|
}
|
|
43
43
|
}
|