@azure/mcp 0.8.2 → 0.8.4

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.
Files changed (2) hide show
  1. package/README.md +69 -130
  2. package/package.json +9 -9
package/README.md CHANGED
@@ -1,148 +1,65 @@
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
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 NPM Package
2
2
 
3
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
4
 
5
- [![Install Azure MCP in VS Code](https://img.shields.io/badge/VS_Code-Install_Azure_MCP_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode:extension/ms-azuretools.vscode-azure-mcp-server) [![Install Azure MCP in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Azure_MCP_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode-insiders:extension/ms-azuretools.vscode-azure-mcp-server) [![Install Azure MCP in Visual Studio](https://img.shields.io/badge/Visual_Studio-Install_Azure_MCP_Server-C16FDE?style=flat-square&logo=visualstudio&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=github-copilot-azure.GitHubCopilotForAzure2022)
6
-
7
-
8
5
  ## Table of Contents
9
6
  - [Overview](#overview)
10
7
  - [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
8
  - [Usage](#usage)
21
9
  - [Getting Started](#getting-started)
22
10
  - [What can you do with the Azure MCP Server?](#what-can-you-do-with-the-azure-mcp-server)
23
11
  - [Complete List of Supported Azure Services](#complete-list-of-supported-azure-services)
24
- - [Support & Reference](#support-and-reference)
12
+ - [Support and Reference](#support-and-reference)
25
13
  - [Documentation](#documentation)
26
- - [Feedback & Support](#feedback-and-support)
14
+ - [Feedback and Support](#feedback-and-support)
27
15
  - [Security](#security)
28
16
  - [Data Collection](#data-collection)
29
- - [Contributing & Code of Conduct](#contributing)
17
+ - [Contributing](#contributing)
18
+ - [Code of Conduct](#code-of-conduct)
30
19
 
31
- # <a id="overview"></a> Overview
20
+ # Overview
32
21
 
33
22
  **Azure MCP Server** supercharges your agents with Azure context across **30+ different Azure services**.
34
23
 
35
- # <a id="installation"></a> Installation
36
-
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)
42
-
43
- 1. Install either the stable or Insiders release of VS Code:
44
- * [💫 Stable release](https://code.visualstudio.com/download)
45
- * [🔮 Insiders release](https://code.visualstudio.com/insiders)
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
47
- 1. Install the [Azure MCP Server](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-mcp-server) extension
48
-
49
- ### <a id="visual-studio-2022"></a> 💜 Visual Studio 2022
50
-
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
58
-
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.
60
- 1. Install the [GitHub Copilot](https://plugins.jetbrains.com/plugin/17718-github-copilot) plugin.
61
- 1. Install the [Azure Toolkit for Intellij](https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij) plugin.
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
- ```
24
+ # Installation
87
25
 
88
- 2. Add `.vscode/mcp.json` or update existing MCP configuration. Replace `/full/path/to/.env` with a path to your `.env` file.
26
+ - To use Azure MCP server from node you must have Node.js (LTS) installed and available on your system PATH — this provides both `npm` and `npx`. We recommend Node.js 20 LTS or later. To verify your installation run: `node --version`, `npm --version`, and `npx --version`.
27
+ - Configure your `mcp.json` file with the following:
89
28
 
90
29
  ```json
91
30
  {
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
- ]
31
+ "mcpServers": {
32
+ "azure-mcp-server": {
33
+ "command": "npx",
34
+ "args": [
35
+ "-y",
36
+ "@azure/mcp@latest",
37
+ "server",
38
+ "start"
39
+ ]
40
+ }
103
41
  }
104
- }
105
42
  }
106
43
  ```
44
+ **Note:** When manually configuring Visual Studio and Visual Studio Code, use `servers` instead of `mcpServers` as the root object.
107
45
 
108
- Optionally, use `--env` or `--volume` to pass authentication values.
109
- </details>
46
+ **Client-Specific Configuration**
47
+ | IDE | File Location | Documentation Link |
48
+ |-----|---------------|-------------------|
49
+ | **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) |
50
+ | **Claude Code** | `~/.claude.json` or `.mcp.json` (project) | [Claude Code MCP Configuration](https://scottspence.com/posts/configuring-mcp-tools-in-claude-code) |
51
+ | **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) |
52
+ | **Cursor** | `~/.cursor/mcp.json` or `.cursor/mcp.json` | [Cursor MCP Documentation](https://docs.cursor.com/context/model-context-protocol) |
53
+ | **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) |
54
+ | **Visual Studio** | `.mcp.json` (solution/workspace) | [Visual Studio MCP Setup](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022) |
55
+ | **VS Code** | `.vscode/mcp.json` (workspace)<br>`settings.json` (user) | [VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) |
56
+ | **Windsurf** | `~/.codeium/windsurf/mcp_config.json` | [Windsurf Cascade MCP Integration](https://docs.windsurf.com/windsurf/cascade/mcp) |
110
57
 
111
- ## <a id="custom-clients"></a> 🤖 Custom Clients
58
+ To use Azure Entra ID, review the [troubleshooting guide](https://github.com/microsoft/mcp/blob/main/servers/Azure.Mcp.Server/TROUBLESHOOTING.md#using-azure-entra-id-with-docker).
112
59
 
113
- You can easily configure your MCP client to use the Azure MCP Server.
60
+ # Usage
114
61
 
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
144
-
145
- ## <a id="getting-started"></a> 🚀 Getting Started
62
+ ## Getting Started
146
63
 
147
64
  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.
148
65
  1. Click `refresh` on the tools list
@@ -153,9 +70,9 @@ For example, add the following `mcp.json` to VS Code. Other clients will look s
153
70
  1. We're building this in the open. Your feedback is much appreciated, and will help us shape the future of the Azure MCP server
154
71
  - 👉 [Open an issue in the public repository](https://github.com/microsoft/mcp/issues/new/choose)
155
72
 
156
- ## <a id="what-can-you-do-with-the-azure-mcp-server"></a> ✨ What can you do with the Azure MCP Server?
73
+ ## What can you do with the Azure MCP Server?
157
74
 
158
- The Azure MCP Server supercharges your agents with Azure context. Here are some cool prompts you can try:
75
+ The Azure MCP Server supercharges your agents with Azure context. Here are some cool prompts you can try:
159
76
 
160
77
  ### 🧮 Azure AI Foundry
161
78
 
@@ -164,12 +81,19 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
164
81
  * List foundry model deployments
165
82
  * List knowledge indexes
166
83
  * Get knowledge index schema configuration
167
-
84
+
168
85
  ### 🔎 Azure AI Search
169
86
 
170
87
  * "What indexes do I have in my Azure AI Search service 'mysvc'?"
171
88
  * "Let's search this index for 'my search query'"
172
89
 
90
+ ### 🎤 Azure AI Services Speech
91
+
92
+ * "Convert this audio file to text using Azure Speech Services"
93
+ * "Recognize speech from my audio file with language detection"
94
+ * "Transcribe speech from audio with profanity filtering"
95
+ * "Transcribe audio with phrase hints for better accuracy"
96
+
173
97
  ### ⚙️ Azure App Configuration
174
98
 
175
99
  * "List my App Configuration stores"
@@ -179,6 +103,18 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
179
103
 
180
104
  * "Help me diagnose issues with my app"
181
105
 
106
+ ### 🕸️ Azure App Service
107
+
108
+ * "List the websites in my subscription"
109
+ * "Show me the websites in my 'my-resource-group' resource group"
110
+ * "Get the details for website 'my-website'"
111
+ * "Get the details for app service plan 'my-app-service-plan'"
112
+
113
+ ### 📦 Azure Container Apps
114
+
115
+ * "List the container apps in my subscription"
116
+ * "Show me the container apps in my 'my-resource-group' resource group"
117
+
182
118
  ### 📦 Azure Container Registry (ACR)
183
119
 
184
120
  * "List all my Azure Container Registries"
@@ -211,6 +147,8 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
211
147
  * "List Event Grid subscriptions for topic 'my-topic' in subscription 'my-subscription'"
212
148
  * "List Event Grid Subscriptions in subscription 'my-subscription'"
213
149
  * "List Event Grid subscriptions for topic 'my-topic' in location 'my-location'"
150
+ * "Publish an event with data '{\"name\": \"test\"}' to topic 'my-topic' using CloudEvents schema"
151
+ * "Send custom event data to Event Grid topic 'analytics-events' with EventGrid schema"
214
152
 
215
153
  ### 🔑 Azure Key Vault
216
154
 
@@ -263,14 +201,17 @@ The Azure MCP Server supercharges your agents with Azure context. Here are some
263
201
  * "Upload my file to the blob container"
264
202
 
265
203
 
266
- ## <a id="complete-list-of-supported-azure-services"></a> 🛠️ Complete List of Supported Azure Services
204
+ ## Complete List of Supported Azure Services
267
205
 
268
206
  The Azure MCP Server provides tools for interacting with **30+ Azure service areas**:
269
207
 
270
208
  - 🧮 **Azure AI Foundry** - AI model management, AI model deployment, and knowledge index management
271
209
  - 🔎 **Azure AI Search** - Search engine/vector database operations
210
+ - 🎤 **Azure AI Services Speech** - Speech-to-text recognition
272
211
  - ⚙️ **Azure App Configuration** - Configuration management
212
+ - 🕸️ **Azure App Service** - Web app hosting
273
213
  - 🛡️ **Azure Best Practices** - Secure, production-grade guidance
214
+ - 📦 **Azure Container Apps** - Container hosting
274
215
  - 📦 **Azure Container Registry (ACR)** - Container registry management
275
216
  - 📊 **Azure Cosmos DB** - NoSQL database operations
276
217
  - 🧮 **Azure Data Explorer** - Analytics queries and KQL
@@ -304,26 +245,26 @@ The Azure MCP Server provides tools for interacting with **30+ Azure service are
304
245
  - 🏗️ **Bicep** - Azure resource templates
305
246
  - 🏗️ **Cloud Architect** - Guided architecture design
306
247
 
307
- # <a id="support-and-reference"></a> Support & Reference
248
+ # Support and Reference
308
249
 
309
- ## <a id="documentation"></a> Documentation
250
+ ## Documentation
310
251
 
311
252
  - 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
253
  - For additional command documentation and examples, see [Azure MCP Commands](https://github.com/microsoft/mcp/blob/main/docs/azmcp-commands.md).
313
254
 
314
- ## <a id="feedback-and-support"></a> Feedback & Support
255
+ ## Feedback and Support
315
256
 
316
257
  - Check the [Troubleshooting guide](https://aka.ms/azmcp/troubleshooting) to diagnose and resolve common issues with the Azure MCP Server.
317
258
  - 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
259
  - 👉 [Open an issue](https://github.com/microsoft/mcp/issues) in the public GitHub repository — we’d love to hear from you!
319
260
 
320
- ## <a id="security"></a> 🛡️ Security
261
+ ## Security
321
262
 
322
263
  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**.
323
264
 
324
265
  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.
325
266
 
326
- ## <a id="data-collection"></a> Data Collection
267
+ ## Data Collection
327
268
 
328
269
  The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's [privacy statement](https://www.microsoft.com/privacy/privacystatement). You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
329
270
 
@@ -333,9 +274,7 @@ Telemetry collection is on by default.
333
274
 
334
275
  To opt out, set the environment variable `AZURE_MCP_COLLECT_TELEMETRY` to `false` in your environment.
335
276
 
336
-
337
-
338
- ## <a id="contributing"></a> 👥 Contributing
277
+ ## Contributing
339
278
 
340
279
  We welcome contributions to the Azure MCP Server! Whether you're fixing bugs, adding new features, or improving documentation, your contributions are welcome.
341
280
 
@@ -347,7 +286,7 @@ Please read our [Contributing Guide](https://github.com/microsoft/mcp/blob/main/
347
286
  * 🔄 Making pull requests
348
287
 
349
288
 
350
- ## <a id="code-of-conduct"></a> 🤝 Code of Conduct
289
+ ## Code of Conduct
351
290
 
352
291
  This project has adopted the
353
292
  [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure/mcp",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
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",
@@ -14,8 +14,8 @@
14
14
  "url": "https://github.com/microsoft/mcp/issues"
15
15
  },
16
16
  "repository": {
17
- "type": "git",
18
- "url": "https://github.com/microsoft/mcp.git"
17
+ "url": "https://github.com/microsoft/mcp.git",
18
+ "type": "git"
19
19
  },
20
20
  "engines": {
21
21
  "node": ">=20.0.0"
@@ -33,12 +33,12 @@
33
33
  "x64"
34
34
  ],
35
35
  "optionalDependencies": {
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"
36
+ "@azure/mcp-linux-arm64": "0.8.4",
37
+ "@azure/mcp-linux-x64": "0.8.4",
38
+ "@azure/mcp-darwin-arm64": "0.8.4",
39
+ "@azure/mcp-darwin-x64": "0.8.4",
40
+ "@azure/mcp-win32-arm64": "0.8.4",
41
+ "@azure/mcp-win32-x64": "0.8.4"
42
42
  },
43
43
  "scripts": {
44
44
  "postinstall": "node ./scripts/post-install-script.js"