@azure/mcp 0.8.0 → 0.8.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 +202 -402
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,25 +1,44 @@
|
|
|
1
1
|
# <img height="36" width="36" src="https://cdn-dynmedia-1.microsoft.com/is/content/microsoftcorp/acom_social_icon_azure" alt="Microsoft Azure Logo" /> 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.
|
|
3
|
+
All Azure MCP tools in a single server. 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.
|
|
4
|
+
|
|
5
|
+
[](https://vscode.dev/redirect?url=vscode:extension/ms-azuretools.vscode-azure-mcp-server) [](https://vscode.dev/redirect?url=vscode-insiders:extension/ms-azuretools.vscode-azure-mcp-server) [](https://marketplace.visualstudio.com/items?itemName=github-copilot-azure.GitHubCopilotForAzure2022)
|
|
6
|
+
|
|
4
7
|
|
|
5
8
|
## Table of Contents
|
|
6
|
-
-
|
|
7
|
-
|
|
8
|
-
- [
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
-
|
|
12
|
-
- [
|
|
9
|
+
- [Overview](#overview)
|
|
10
|
+
- [Installation](#installation)
|
|
11
|
+
- [IDE Extensions](#ide-extensions)
|
|
12
|
+
- [VS Code (Recommended)](#vs-code-recommended)
|
|
13
|
+
- [Visual Studio 2022](#visual-studio-2022)
|
|
14
|
+
- [IntelliJ IDEA](#intellij-idea)
|
|
15
|
+
- [Package Managers](#package-managers)
|
|
16
|
+
- [NuGet](#nuget)
|
|
17
|
+
- [NPM](#npm)
|
|
18
|
+
- [Docker](#docker)
|
|
19
|
+
- [Custom Clients](#custom-clients)
|
|
20
|
+
- [Usage](#usage)
|
|
21
|
+
- [Getting Started](#getting-started)
|
|
13
22
|
- [What can you do with the Azure MCP Server?](#what-can-you-do-with-the-azure-mcp-server)
|
|
14
|
-
- [
|
|
15
|
-
- Support & Reference
|
|
23
|
+
- [Complete List of Supported Azure Services](#complete-list-of-supported-azure-services)
|
|
24
|
+
- [Support & Reference](#support-and-reference)
|
|
25
|
+
- [Documentation](#documentation)
|
|
26
|
+
- [Feedback & Support](#feedback-and-support)
|
|
27
|
+
- [Security](#security)
|
|
16
28
|
- [Data Collection](#data-collection)
|
|
17
|
-
- [
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
29
|
+
- [Contributing & Code of Conduct](#contributing)
|
|
30
|
+
|
|
31
|
+
# <a id="overview"></a> Overview
|
|
32
|
+
|
|
33
|
+
**Azure MCP Server** supercharges your agents with Azure context across **30+ different Azure services**.
|
|
34
|
+
|
|
35
|
+
# <a id="installation"></a> Installation
|
|
21
36
|
|
|
22
|
-
## <a id="
|
|
37
|
+
## <a id="ide-extensions"></a> 🧩 IDE Extensions
|
|
38
|
+
|
|
39
|
+
Follow these simple steps to start using Azure MCP with your favorite IDE. We recommend VS Code:
|
|
40
|
+
|
|
41
|
+
### <a id="vs-code-recommended"></a> 🔷 VS Code (Recommended)
|
|
23
42
|
|
|
24
43
|
1. Install either the stable or Insiders release of VS Code:
|
|
25
44
|
* [💫 Stable release](https://code.visualstudio.com/download)
|
|
@@ -27,15 +46,103 @@ The Azure MCP Server implements the [MCP specification](https://modelcontextprot
|
|
|
27
46
|
1. 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
|
|
28
47
|
1. Install the [Azure MCP Server](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-mcp-server) extension
|
|
29
48
|
|
|
49
|
+
### <a id="visual-studio-2022"></a> 💜 Visual Studio 2022
|
|
30
50
|
|
|
31
|
-
|
|
51
|
+
From within Visual Studio 2022 install [GitHub Copilot for Azure (VS 2022)](https://marketplace.visualstudio.com/items?itemName=github-copilot-azure.GitHubCopilotForAzure2022):
|
|
52
|
+
1. Go to `Extensions | Manage Extensions...`
|
|
53
|
+
2. Switch to the `Browse` tab in `Extension Manager`
|
|
54
|
+
3. Search for `Github Copilot for Azure`
|
|
55
|
+
4. Click `Install`
|
|
56
|
+
|
|
57
|
+
### <a id="intellij-idea"></a> ☕ IntelliJ IDEA
|
|
32
58
|
|
|
33
59
|
1. Install either the [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download) or [IntelliJ IDEA Community](https://www.jetbrains.com/idea/download) edition.
|
|
34
60
|
1. Install the [GitHub Copilot](https://plugins.jetbrains.com/plugin/17718-github-copilot) plugin.
|
|
35
61
|
1. Install the [Azure Toolkit for Intellij](https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij) plugin.
|
|
36
62
|
|
|
63
|
+
## <a id="package-managers"></a> Package Managers
|
|
64
|
+
|
|
65
|
+
### <a id="nuget"></a> 🤖 NuGet
|
|
66
|
+
|
|
67
|
+
Microsoft publishes an official Azure MCP Server .NET Tool on NuGet: [Azure.Mcp](https://www.nuget.org/packages/Azure.Mcp).
|
|
68
|
+
|
|
69
|
+
### <a id="npm"></a> 📦 NPM
|
|
70
|
+
|
|
71
|
+
Microsoft publishes an official Azure MCP Server npm package for Node.js: [@azure/mcp](https://www.npmjs.com/package/@azure/mcp).
|
|
72
|
+
|
|
73
|
+
### <a id="docker"></a> 🐋 Docker
|
|
74
|
+
|
|
75
|
+
Microsoft publishes an official Azure MCP Server Docker container on the [Microsoft Artifact Registry](https://mcr.microsoft.com/artifact/mar/azure-sdk/azure-mcp).
|
|
76
|
+
|
|
77
|
+
<details>
|
|
78
|
+
<summary>For a step-by-step Docker installation, follow these instructions:</summary>
|
|
79
|
+
|
|
80
|
+
1. 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:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
AZURE_TENANT_ID={YOUR_AZURE_TENANT_ID}
|
|
84
|
+
AZURE_CLIENT_ID={YOUR_AZURE_CLIENT_ID}
|
|
85
|
+
AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
2. Add `.vscode/mcp.json` or update existing MCP configuration. Replace `/full/path/to/.env` with a path to your `.env` file.
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"servers": {
|
|
93
|
+
"Azure MCP Server": {
|
|
94
|
+
"command": "docker",
|
|
95
|
+
"args": [
|
|
96
|
+
"run",
|
|
97
|
+
"-i",
|
|
98
|
+
"--rm",
|
|
99
|
+
"--env-file",
|
|
100
|
+
"/full/path/to/.env",
|
|
101
|
+
"mcr.microsoft.com/azure-sdk/azure-mcp:latest",
|
|
102
|
+
]
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Optionally, use `--env` or `--volume` to pass authentication values.
|
|
109
|
+
</details>
|
|
110
|
+
|
|
111
|
+
## <a id="custom-clients"></a> 🤖 Custom Clients
|
|
112
|
+
|
|
113
|
+
You can easily configure your MCP client to use the Azure MCP Server.
|
|
114
|
+
|
|
115
|
+
<details>
|
|
116
|
+
<summary>Have your client run the following command and access it via standard IO:</summary>
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
npx -y @azure/mcp@latest server start
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
For example, add the following `mcp.json` to VS Code. Other clients will look similar, but may be structured slightly different. Consult the documentation of the custom client for details.
|
|
123
|
+
|
|
124
|
+
1. Example `mcp.json`:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"servers": {
|
|
129
|
+
"Azure MCP Server": {
|
|
130
|
+
"command": "npx",
|
|
131
|
+
"args": [
|
|
132
|
+
"-y",
|
|
133
|
+
"@azure/mcp@latest",
|
|
134
|
+
"server",
|
|
135
|
+
"start"
|
|
136
|
+
]
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
</details>
|
|
142
|
+
|
|
143
|
+
# <a id="usage"></a> Usage
|
|
37
144
|
|
|
38
|
-
## <a id="
|
|
145
|
+
## <a id="getting-started"></a> 🚀 Getting Started
|
|
39
146
|
|
|
40
147
|
1. Open GitHub Copilot in [VS Code](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) or [IntelliJ](https://github.blog/changelog/2025-05-19-agent-mode-and-mcp-support-for-copilot-in-jetbrains-eclipse-and-xcode-now-in-public-preview/#agent-mode) and switch to Agent mode.
|
|
41
148
|
1. Click `refresh` on the tools list
|
|
@@ -50,6 +157,14 @@ The Azure MCP Server implements the [MCP specification](https://modelcontextprot
|
|
|
50
157
|
|
|
51
158
|
The Azure MCP Server supercharges your agents with Azure context. Here are some cool prompts you can try:
|
|
52
159
|
|
|
160
|
+
### 🧮 Azure AI Foundry
|
|
161
|
+
|
|
162
|
+
* List Azure Foundry models
|
|
163
|
+
* Deploy foundry models
|
|
164
|
+
* List foundry model deployments
|
|
165
|
+
* List knowledge indexes
|
|
166
|
+
* Get knowledge index schema configuration
|
|
167
|
+
|
|
53
168
|
### 🔎 Azure AI Search
|
|
54
169
|
|
|
55
170
|
* "What indexes do I have in my Azure AI Search service 'mysvc'?"
|
|
@@ -97,6 +212,16 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
|
|
|
97
212
|
* "List Event Grid Subscriptions in subscription 'my-subscription'"
|
|
98
213
|
* "List Event Grid subscriptions for topic 'my-topic' in location 'my-location'"
|
|
99
214
|
|
|
215
|
+
### 🔑 Azure Key Vault
|
|
216
|
+
|
|
217
|
+
* "List all secrets in my key vault 'my-vault'"
|
|
218
|
+
* "Create a new secret called 'apiKey' with value 'xyz' in key vault 'my-vault'"
|
|
219
|
+
* "List all keys in key vault 'my-vault'"
|
|
220
|
+
* "Create a new RSA key called 'encryption-key' in key vault 'my-vault'"
|
|
221
|
+
* "List all certificates in key vault 'my-vault'"
|
|
222
|
+
* "Import a certificate file into key vault 'my-vault' using the name 'tls-cert'"
|
|
223
|
+
* "Get the account settings for my key vault 'my-vault'"
|
|
224
|
+
|
|
100
225
|
### ⚡ Azure Managed Lustre
|
|
101
226
|
|
|
102
227
|
* "List the Azure Managed Lustre clusters in resource group 'my-resource-group'"
|
|
@@ -114,9 +239,12 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
|
|
|
114
239
|
|
|
115
240
|
### 🗄️ Azure SQL Database
|
|
116
241
|
|
|
242
|
+
* "List all SQL servers in my subscription"
|
|
243
|
+
* "List all SQL servers in my resource group 'my-resource-group'"
|
|
117
244
|
* "Show me details about my Azure SQL database 'mydb'"
|
|
118
245
|
* "List all databases in my Azure SQL server 'myserver'"
|
|
119
246
|
* "Update the performance tier of my Azure SQL database 'mydb'"
|
|
247
|
+
* "Rename my Azure SQL database 'mydb' to 'newname'"
|
|
120
248
|
* "List all firewall rules for my Azure SQL server 'myserver'"
|
|
121
249
|
* "Create a firewall rule for my Azure SQL server 'myserver'"
|
|
122
250
|
* "Delete a firewall rule from my Azure SQL server 'myserver'"
|
|
@@ -131,374 +259,69 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
|
|
|
131
259
|
* "List my Azure storage accounts"
|
|
132
260
|
* "Get details about my storage account 'mystorageaccount'"
|
|
133
261
|
* "Create a new storage account in East US with Data Lake support"
|
|
134
|
-
* "Show me the tables in my Storage account"
|
|
135
262
|
* "Get details about my Storage container"
|
|
136
263
|
* "Upload my file to the blob container"
|
|
137
|
-
* "List paths in my Data Lake file system"
|
|
138
|
-
* "List files and directories in my File Share"
|
|
139
|
-
* "Send a message to my storage queue"
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
## <a id="currently-supported-tools"></a> 🛠️ Currently Supported Tools
|
|
143
|
-
|
|
144
|
-
<details>
|
|
145
|
-
<summary>The Azure MCP Server provides tools for interacting with the following Azure services</summary>
|
|
146
|
-
|
|
147
|
-
### 🔎 Azure AI Search (search engine/vector database)
|
|
148
|
-
|
|
149
|
-
* List Azure AI Search services
|
|
150
|
-
* List indexes and look at their schema and configuration
|
|
151
|
-
* Query search indexes
|
|
152
|
-
|
|
153
|
-
### ⚙️ Azure App Configuration
|
|
154
|
-
|
|
155
|
-
* List App Configuration stores
|
|
156
|
-
* Manage key-value pairs
|
|
157
|
-
* Handle labeled configurations
|
|
158
|
-
* Lock/unlock configuration settings
|
|
159
|
-
|
|
160
|
-
### 🛡️ Azure Best Practices
|
|
161
|
-
|
|
162
|
-
* Get secure, production-grade Azure SDK best practices for effective code generation.
|
|
163
|
-
|
|
164
|
-
### 📦 Azure Container Registry (ACR)
|
|
165
|
-
|
|
166
|
-
* List Azure Container Registries and repositories in a subscription
|
|
167
|
-
* Filter container registries and repositories by resource group
|
|
168
|
-
* JSON output formatting
|
|
169
|
-
* Cross-platform compatibility
|
|
170
|
-
|
|
171
|
-
### 📊 Azure Cosmos DB (NoSQL Databases)
|
|
172
|
-
|
|
173
|
-
* List Cosmos DB accounts
|
|
174
|
-
* List and query databases
|
|
175
|
-
* Manage containers and items
|
|
176
|
-
* Execute SQL queries against containers
|
|
177
|
-
|
|
178
|
-
### 🧮 Azure Data Explorer
|
|
179
|
-
|
|
180
|
-
* List Azure Data Explorer clusters
|
|
181
|
-
* List databases
|
|
182
|
-
* List tables
|
|
183
|
-
* Get schema for a table
|
|
184
|
-
* Sample rows from a table
|
|
185
|
-
* Query using KQL
|
|
186
|
-
|
|
187
|
-
### 🐬 Azure Database for MySQL - Flexible Server
|
|
188
|
-
|
|
189
|
-
* List and query databases.
|
|
190
|
-
* List and get schema for tables.
|
|
191
|
-
* List, get configuration and get parameters for servers.
|
|
192
|
-
|
|
193
|
-
### 🐘 Azure Database for PostgreSQL - Flexible Server
|
|
194
|
-
|
|
195
|
-
* List and query databases.
|
|
196
|
-
* List and get schema for tables.
|
|
197
|
-
* List, get configuration and get/set parameters for servers.
|
|
198
|
-
|
|
199
|
-
### 🚀 Azure Deploy
|
|
200
|
-
|
|
201
|
-
* Generate Azure service architecture diagrams from source code
|
|
202
|
-
* Create a deploy plan for provisioning and deploying the application
|
|
203
|
-
* Get the application service log for a specific azd environment
|
|
204
|
-
* Get the bicep or terraform file generation rules for an application
|
|
205
|
-
* Get the GitHub pipeline creation guideline for an application
|
|
206
|
-
|
|
207
|
-
### 📣 Azure Event Grid
|
|
208
|
-
|
|
209
|
-
* List Event Grid topics in subscription or resource group
|
|
210
|
-
* View topic configuration and status information
|
|
211
|
-
* Access endpoint and key details for event publishing
|
|
212
|
-
* List Event Grid subscriptions with filtering by topic name, resource group, and location
|
|
213
|
-
* View subscription details including destination endpoints and retry policies
|
|
214
|
-
|
|
215
|
-
### 🧮 Azure Foundry
|
|
216
|
-
|
|
217
|
-
* List Azure Foundry models
|
|
218
|
-
* Deploy foundry models
|
|
219
|
-
* List foundry model deployments
|
|
220
|
-
* List knowledge indexes
|
|
221
|
-
|
|
222
|
-
### ☁️ Azure Function App
|
|
223
|
-
|
|
224
|
-
* List Azure Function Apps
|
|
225
|
-
* Get details for a specific Function App
|
|
226
|
-
|
|
227
|
-
### 🔑 Azure Key Vault
|
|
228
|
-
|
|
229
|
-
* List, create, and import certificates
|
|
230
|
-
* List and create keys
|
|
231
|
-
* List and create secrets
|
|
232
|
-
|
|
233
|
-
### ☸️ Azure Kubernetes Service (AKS)
|
|
234
|
-
|
|
235
|
-
* List Azure Kubernetes Service clusters
|
|
236
|
-
* List node pools in an AKS managed cluster
|
|
237
|
-
* Get details of a node pool in an AKS managed cluster
|
|
238
|
-
|
|
239
|
-
### 📦 Azure Load Testing
|
|
240
|
-
|
|
241
|
-
* List, create load test resources
|
|
242
|
-
* List, create load tests
|
|
243
|
-
* Get, list, (create) run and rerun, update load test runs
|
|
244
|
-
|
|
245
|
-
### 🚀 Azure Managed Grafana
|
|
246
|
-
|
|
247
|
-
* List Azure Managed Grafana
|
|
248
|
-
|
|
249
|
-
### ⚡ Azure Managed Lustre
|
|
250
|
-
|
|
251
|
-
* List Azure Managed Lustre filesystems
|
|
252
|
-
* Get the number of IP addresses required for a specific SKU and size of Azure Managed Lustre filesystem
|
|
253
|
-
* Get information of Azure Managed Lustre SKUs available in a specific Azure region
|
|
254
|
-
|
|
255
|
-
### 🏪 Azure Marketplace
|
|
256
|
-
|
|
257
|
-
* List marketplace products available to a subscription with filtering capabilities
|
|
258
|
-
* Get details about Marketplace products
|
|
259
|
-
|
|
260
|
-
### 📈 Azure Monitor
|
|
261
|
-
|
|
262
|
-
#### Log Analytics
|
|
263
|
-
|
|
264
|
-
* List Log Analytics workspaces
|
|
265
|
-
* Query logs using KQL
|
|
266
|
-
* List available tables
|
|
267
|
-
|
|
268
|
-
#### Health Models
|
|
269
|
-
|
|
270
|
-
* Get health of an entity
|
|
271
|
-
|
|
272
|
-
#### Metrics
|
|
273
|
-
|
|
274
|
-
* Query Azure Monitor metrics for resources with time series data
|
|
275
|
-
* List available metric definitions for resources
|
|
276
|
-
|
|
277
|
-
### ⚙️ Azure Native ISV Services
|
|
278
|
-
|
|
279
|
-
* List Monitored Resources in a Datadog Monitor
|
|
280
|
-
|
|
281
|
-
### 🛡️ Azure Quick Review CLI Extension
|
|
282
264
|
|
|
283
|
-
* Scan Azure resources for compliance related recommendations
|
|
284
265
|
|
|
285
|
-
|
|
266
|
+
## <a id="complete-list-of-supported-azure-services"></a> 🛠️ Complete List of Supported Azure Services
|
|
267
|
+
|
|
268
|
+
The Azure MCP Server provides tools for interacting with **30+ Azure service areas**:
|
|
269
|
+
|
|
270
|
+
- 🧮 **Azure AI Foundry** - AI model management, AI model deployment, and knowledge index management
|
|
271
|
+
- 🔎 **Azure AI Search** - Search engine/vector database operations
|
|
272
|
+
- ⚙️ **Azure App Configuration** - Configuration management
|
|
273
|
+
- 🛡️ **Azure Best Practices** - Secure, production-grade guidance
|
|
274
|
+
- 📦 **Azure Container Registry (ACR)** - Container registry management
|
|
275
|
+
- 📊 **Azure Cosmos DB** - NoSQL database operations
|
|
276
|
+
- 🧮 **Azure Data Explorer** - Analytics queries and KQL
|
|
277
|
+
- 🐬 **Azure Database for MySQL** - MySQL database management
|
|
278
|
+
- 🐘 **Azure Database for PostgreSQL** - PostgreSQL database management
|
|
279
|
+
- 📊 **Azure Event Grid** - Event routing and management
|
|
280
|
+
- ⚡ **Azure Functions** - Function App management
|
|
281
|
+
- 🔑 **Azure Key Vault** - Secrets, keys, and certificates
|
|
282
|
+
- ☸️ **Azure Kubernetes Service (AKS)** - Container orchestration
|
|
283
|
+
- 📦 **Azure Load Testing** - Performance testing
|
|
284
|
+
- 🚀 **Azure Managed Grafana** - Monitoring dashboards
|
|
285
|
+
- 🗃️ **Azure Managed Lustre** - High-performance Lustre filesystem operations
|
|
286
|
+
- 🏪 **Azure Marketplace** - Product discovery
|
|
287
|
+
- 📈 **Azure Monitor** - Logging, metrics, and health monitoring
|
|
288
|
+
- ⚙️ **Azure Native ISV Services** - Third-party integrations
|
|
289
|
+
- 🛡️ **Azure Quick Review CLI** - Compliance scanning
|
|
290
|
+
- 📊 **Azure Quota** - Resource quota and usage management
|
|
291
|
+
- 🎭 **Azure RBAC** - Access control management
|
|
292
|
+
- 🔴 **Azure Redis Cache** - In-memory data store
|
|
293
|
+
- 🏗️ **Azure Resource Groups** - Resource organization
|
|
294
|
+
- 🗄️ **Azure SQL Database** - Relational database management
|
|
295
|
+
- 🗄️ **Azure SQL Elastic Pool** - Database resource sharing
|
|
296
|
+
- 🗄️ **Azure SQL Server** - Server administration
|
|
297
|
+
- 🚌 **Azure Service Bus** - Message queuing
|
|
298
|
+
- 🏥 **Azure Service Health** - Resource health status and availability
|
|
299
|
+
- 💾 **Azure Storage** - Blob storage
|
|
300
|
+
- 📋 **Azure Subscription** - Subscription management
|
|
301
|
+
- 🏗️ **Azure Terraform Best Practices** - Infrastructure as code guidance
|
|
302
|
+
- 🖥️ **Azure Virtual Desktop** - Virtual desktop infrastructure
|
|
303
|
+
- 📊 **Azure Workbooks** - Custom visualizations
|
|
304
|
+
- 🏗️ **Bicep** - Azure resource templates
|
|
305
|
+
- 🏗️ **Cloud Architect** - Guided architecture design
|
|
306
|
+
|
|
307
|
+
# <a id="support-and-reference"></a> Support & Reference
|
|
308
|
+
|
|
309
|
+
## <a id="documentation"></a> Documentation
|
|
310
|
+
|
|
311
|
+
- See our [official documentation on learn.microsoft.com](https://learn.microsoft.com/azure/developer/azure-mcp-server/) to learn how to use the Azure MCP Server to interact with Azure resources through natural language commands from AI agents and other types of clients.
|
|
312
|
+
- For additional command documentation and examples, see [Azure MCP Commands](https://github.com/microsoft/mcp/blob/main/docs/azmcp-commands.md).
|
|
313
|
+
|
|
314
|
+
## <a id="feedback-and-support"></a> Feedback & Support
|
|
315
|
+
|
|
316
|
+
- Check the [Troubleshooting guide](https://aka.ms/azmcp/troubleshooting) to diagnose and resolve common issues with the Azure MCP Server.
|
|
317
|
+
- We're building this in the open. Your feedback is much appreciated, and will help us shape the future of the Azure MCP server.
|
|
318
|
+
- 👉 [Open an issue](https://github.com/microsoft/mcp/issues) in the public GitHub repository — we’d love to hear from you!
|
|
319
|
+
|
|
320
|
+
## <a id="security"></a> 🛡️ Security
|
|
286
321
|
|
|
287
|
-
|
|
288
|
-
* Check quota usage
|
|
289
|
-
|
|
290
|
-
### 🔴 Azure Redis Cache
|
|
291
|
-
|
|
292
|
-
* List Redis Cluster resources
|
|
293
|
-
* List databases in Redis Clusters
|
|
294
|
-
* List Redis Cache resources
|
|
295
|
-
* List access policies for Redis Caches
|
|
296
|
-
|
|
297
|
-
### 🏗️ Azure Resource Groups
|
|
298
|
-
|
|
299
|
-
* List resource groups
|
|
300
|
-
|
|
301
|
-
### 🏥 Azure Resource Health
|
|
302
|
-
|
|
303
|
-
* Get the availability status for a specific resource
|
|
304
|
-
* List availability statuses for all resources in a subscription or resource group
|
|
305
|
-
* List service health events in a subscription
|
|
306
|
-
|
|
307
|
-
### 🎭 Azure Role-Based Access Control (RBAC)
|
|
308
|
-
|
|
309
|
-
* List role assignments
|
|
310
|
-
|
|
311
|
-
### 🚌 Azure Service Bus
|
|
312
|
-
|
|
313
|
-
* Examine properties and runtime information about queues, topics, and subscriptions
|
|
314
|
-
|
|
315
|
-
### 🗄️ Azure SQL Database
|
|
316
|
-
|
|
317
|
-
* Show database details and properties
|
|
318
|
-
* List the details and properties of all databases
|
|
319
|
-
* Create a SQL database
|
|
320
|
-
* Update a SQL database configuration
|
|
321
|
-
* Delete a SQL database
|
|
322
|
-
* List SQL server firewall rules
|
|
323
|
-
* Create SQL server firewall rules
|
|
324
|
-
* Delete SQL server firewall rules
|
|
325
|
-
* List elastic pools in SQL servers
|
|
326
|
-
* List Microsoft Entra ID administrators for SQL servers
|
|
327
|
-
* Create new SQL servers
|
|
328
|
-
* Show details and properties of SQL servers
|
|
329
|
-
* Delete SQL servers
|
|
330
|
-
|
|
331
|
-
### 💾 Azure Storage
|
|
332
|
-
|
|
333
|
-
* List and create Storage accounts
|
|
334
|
-
* Get detailed information about specific Storage accounts
|
|
335
|
-
* Manage blob containers and blobs
|
|
336
|
-
* Upload files to blobs
|
|
337
|
-
* List and query Storage tables
|
|
338
|
-
* List paths in Data Lake file systems
|
|
339
|
-
* Get container properties and metadata
|
|
340
|
-
* List files and directories in File Shares
|
|
341
|
-
|
|
342
|
-
### 📋 Azure Subscription
|
|
343
|
-
|
|
344
|
-
* List Azure subscriptions
|
|
345
|
-
|
|
346
|
-
### 🏗️ Azure Terraform Best Practices
|
|
347
|
-
|
|
348
|
-
* Get secure, production-grade Azure Terraform best practices for effective code generation and command execution
|
|
349
|
-
|
|
350
|
-
### 🖥️ Azure Virtual Desktop
|
|
351
|
-
|
|
352
|
-
* List Azure Virtual Desktop host pools
|
|
353
|
-
* List session hosts in host pools
|
|
354
|
-
* List user sessions on a session host
|
|
355
|
-
|
|
356
|
-
### 📊 Azure Workbooks
|
|
357
|
-
|
|
358
|
-
* List workbooks in resource groups
|
|
359
|
-
* Create new workbooks with custom visualizations
|
|
360
|
-
* Update existing workbook configurations
|
|
361
|
-
* Get workbook details and metadata
|
|
362
|
-
* Delete workbooks when no longer needed
|
|
363
|
-
|
|
364
|
-
### 🏗️ Bicep
|
|
365
|
-
|
|
366
|
-
* Get the Bicep schema for specific Azure resource types
|
|
367
|
-
|
|
368
|
-
### 🏗️ Cloud Architect
|
|
369
|
-
|
|
370
|
-
* Design Azure cloud architectures through guided questions
|
|
371
|
-
|
|
372
|
-
Agents and models can discover and learn best practices and usage guidelines for the `azd` MCP tool. For more information, see [AZD Best Practices](https://github.com/microsoft/mcp/tree/main/tools/Azure.Mcp.Tools.Extension/src/Resources/azd-best-practices.txt).
|
|
373
|
-
|
|
374
|
-
</details>
|
|
375
|
-
|
|
376
|
-
For detailed command documentation and examples, see [Azure MCP Commands](https://github.com/microsoft/mcp/blob/main/docs/azmcp-commands.md).
|
|
377
|
-
|
|
378
|
-
## <a id="upgrading"></a> 🔄️ Upgrading
|
|
379
|
-
|
|
380
|
-
<details>
|
|
381
|
-
<summary>How to stay current with releases of Azure MCP Server</summary>
|
|
382
|
-
|
|
383
|
-
#### NPX
|
|
384
|
-
|
|
385
|
-
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.
|
|
386
|
-
|
|
387
|
-
#### NPM
|
|
388
|
-
|
|
389
|
-
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`.
|
|
390
|
-
|
|
391
|
-
#### Docker
|
|
392
|
-
|
|
393
|
-
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).
|
|
394
|
-
|
|
395
|
-
#### VS Code
|
|
396
|
-
|
|
397
|
-
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.
|
|
398
|
-
|
|
399
|
-
#### IntelliJ
|
|
400
|
-
|
|
401
|
-
If the Azure MCP server is configured by Azure Toolkit for IntelliJ plugin, the version is automatically updated to the latest version when the IntelliJ project starts. If the Azure MCP server is manually configured with `npx` command and `-y @azure/mcp@latest` args, npx will check for package updates each time IntelliJ starts the server. Using a docker container in IntelliJ has the same no-update limitation described above.
|
|
402
|
-
|
|
403
|
-
</details>
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
## <a id="advanced-install-scenarios-optional"></a> ⚙️ Advanced Install Scenarios (Optional)
|
|
407
|
-
|
|
408
|
-
<details>
|
|
409
|
-
<summary>Docker containers, custom MCP clients, and manual install options</summary>
|
|
410
|
-
|
|
411
|
-
### 🐋 Docker Install Steps (Optional)
|
|
412
|
-
|
|
413
|
-
Microsoft publishes an official Azure MCP Server Docker container on the [Microsoft Artifact Registry](https://mcr.microsoft.com/artifact/mar/azure-sdk/azure-mcp).
|
|
414
|
-
|
|
415
|
-
For a step-by-step Docker installation, follow these instructions:
|
|
416
|
-
|
|
417
|
-
1. 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:
|
|
418
|
-
|
|
419
|
-
```bash
|
|
420
|
-
AZURE_TENANT_ID={YOUR_AZURE_TENANT_ID}
|
|
421
|
-
AZURE_CLIENT_ID={YOUR_AZURE_CLIENT_ID}
|
|
422
|
-
AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
|
|
423
|
-
```
|
|
424
|
-
|
|
425
|
-
2. Add `.vscode/mcp.json` or update existing MCP configuration. Replace `/full/path/to/.env` with a path to your `.env` file.
|
|
426
|
-
|
|
427
|
-
```json
|
|
428
|
-
{
|
|
429
|
-
"servers": {
|
|
430
|
-
"Azure MCP Server": {
|
|
431
|
-
"command": "docker",
|
|
432
|
-
"args": [
|
|
433
|
-
"run",
|
|
434
|
-
"-i",
|
|
435
|
-
"--rm",
|
|
436
|
-
"--env-file",
|
|
437
|
-
"/full/path/to/.env"
|
|
438
|
-
"mcr.microsoft.com/azure-sdk/azure-mcp:latest",
|
|
439
|
-
]
|
|
440
|
-
}
|
|
441
|
-
}
|
|
442
|
-
}
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
Optionally, use `--env` or `--volume` to pass authentication values.
|
|
446
|
-
|
|
447
|
-
### 🤖 Custom MCP Client Install Steps (Optional)
|
|
448
|
-
|
|
449
|
-
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.
|
|
450
|
-
|
|
451
|
-
```bash
|
|
452
|
-
npx -y @azure/mcp@latest server start
|
|
453
|
-
```
|
|
454
|
-
|
|
455
|
-
### 🔧 Manual Install Steps (Optional)
|
|
456
|
-
|
|
457
|
-
For a step-by-step installation, follow these instructions:
|
|
458
|
-
|
|
459
|
-
1. Add `.vscode/mcp.json`:
|
|
460
|
-
|
|
461
|
-
```json
|
|
462
|
-
{
|
|
463
|
-
"servers": {
|
|
464
|
-
"Azure MCP Server": {
|
|
465
|
-
"command": "npx",
|
|
466
|
-
"args": [
|
|
467
|
-
"-y",
|
|
468
|
-
"@azure/mcp@latest",
|
|
469
|
-
"server",
|
|
470
|
-
"start"
|
|
471
|
-
]
|
|
472
|
-
}
|
|
473
|
-
}
|
|
474
|
-
}
|
|
475
|
-
```
|
|
476
|
-
|
|
477
|
-
You can optionally set the `--namespace <namespace>` flag to install tools for the specified Azure product or service.
|
|
478
|
-
|
|
479
|
-
1. Add `.vscode/mcp.json`:
|
|
480
|
-
|
|
481
|
-
```json
|
|
482
|
-
{
|
|
483
|
-
"servers": {
|
|
484
|
-
"Azure Best Practices": {
|
|
485
|
-
"command": "npx",
|
|
486
|
-
"args": [
|
|
487
|
-
"-y",
|
|
488
|
-
"@azure/mcp@latest",
|
|
489
|
-
"server",
|
|
490
|
-
"start",
|
|
491
|
-
"--namespace",
|
|
492
|
-
"bestpractices" // Any of the available MCP servers can be referenced here.
|
|
493
|
-
]
|
|
494
|
-
}
|
|
495
|
-
}
|
|
496
|
-
}
|
|
497
|
-
```
|
|
498
|
-
|
|
499
|
-
More end-to-end MCP client/agent guides are coming soon!
|
|
500
|
-
</details>
|
|
322
|
+
Your credentials are always handled securely through the official [Azure Identity SDK](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md) - **we never store or manage tokens directly**.
|
|
501
323
|
|
|
324
|
+
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.
|
|
502
325
|
|
|
503
326
|
## <a id="data-collection"></a> Data Collection
|
|
504
327
|
|
|
@@ -511,29 +334,6 @@ Telemetry collection is on by default.
|
|
|
511
334
|
To opt out, set the environment variable `AZURE_MCP_COLLECT_TELEMETRY` to `false` in your environment.
|
|
512
335
|
|
|
513
336
|
|
|
514
|
-
## <a id="troubleshooting"></a> 📝 Troubleshooting
|
|
515
|
-
|
|
516
|
-
See [Troubleshooting guide](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/TROUBLESHOOTING.md) for help with common issues and logging.
|
|
517
|
-
|
|
518
|
-
### 🔑 Authentication
|
|
519
|
-
|
|
520
|
-
<details>
|
|
521
|
-
<summary>Authentication options including DefaultAzureCredential flow, RBAC permissions, troubleshooting, and production credentials</summary>
|
|
522
|
-
|
|
523
|
-
The Azure MCP Server uses the Azure Identity library for .NET to authenticate to Microsoft Entra ID. For detailed information, see [Authentication Fundamentals](https://github.com/microsoft/mcp/blob/main/docs/Authentication.md#authentication-fundamentals).
|
|
524
|
-
|
|
525
|
-
If you're running into any issues with authentication, visit our [troubleshooting guide](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/TROUBLESHOOTING.md#authentication).
|
|
526
|
-
|
|
527
|
-
For enterprise authentication scenarios, including network restrictions, security policies, and protected resources, see [Authentication Scenarios in Enterprise Environments](https://github.com/microsoft/mcp/blob/main/docs/Authentication.md#authentication-scenarios-in-enterprise-environments).
|
|
528
|
-
</details>
|
|
529
|
-
|
|
530
|
-
## <a id="security-note"></a> 🛡️ Security Note
|
|
531
|
-
|
|
532
|
-
Your credentials are always handled securely through the official [Azure Identity SDK](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md) - **we never store or manage tokens directly**.
|
|
533
|
-
|
|
534
|
-
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.
|
|
535
|
-
|
|
536
|
-
|
|
537
337
|
|
|
538
338
|
## <a id="contributing"></a> 👥 Contributing
|
|
539
339
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure/mcp",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.2",
|
|
4
4
|
"description": "Azure MCP Server - Model Context Protocol implementation for Azure",
|
|
5
5
|
"author": "Microsoft",
|
|
6
6
|
"homepage": "https://github.com/Microsoft/mcp/blob/main/servers/Azure.Mcp.Server#readme",
|
|
@@ -33,12 +33,12 @@
|
|
|
33
33
|
"x64"
|
|
34
34
|
],
|
|
35
35
|
"optionalDependencies": {
|
|
36
|
-
"@azure/mcp-linux-arm64": "0.8.
|
|
37
|
-
"@azure/mcp-linux-x64": "0.8.
|
|
38
|
-
"@azure/mcp-darwin-arm64": "0.8.
|
|
39
|
-
"@azure/mcp-darwin-x64": "0.8.
|
|
40
|
-
"@azure/mcp-win32-arm64": "0.8.
|
|
41
|
-
"@azure/mcp-win32-x64": "0.8.
|
|
36
|
+
"@azure/mcp-linux-arm64": "0.8.2",
|
|
37
|
+
"@azure/mcp-linux-x64": "0.8.2",
|
|
38
|
+
"@azure/mcp-darwin-arm64": "0.8.2",
|
|
39
|
+
"@azure/mcp-darwin-x64": "0.8.2",
|
|
40
|
+
"@azure/mcp-win32-arm64": "0.8.2",
|
|
41
|
+
"@azure/mcp-win32-x64": "0.8.2"
|
|
42
42
|
},
|
|
43
43
|
"scripts": {
|
|
44
44
|
"postinstall": "node ./scripts/post-install-script.js"
|