Merge pull request #311160 from mumian/0127-mcp

Document Bicep MCP Server

Author: denrea

.openpublishing.redirection.json

@@ -2755,6 +2755,11 @@
       "redirect_url": "/azure/azure-portal/azure-portal-supported-browsers-devices",
       "redirect_document_id": false
     },
+    {
+      "source_path_from_root": "/articles/azure-resource-manager/bicep/deploy-vscode.md",
+      "redirect_url": "/azure/azure-resource-manager/bicep/deploy-visual-studio-code",
+      "redirect_document_id": false
+    },
     {
       "source_path_from_root": "/articles/azure-resource-manager/management/control-plane-metrics.md",
       "redirect_url": "/azure/azure-resource-manager/management/monitor-resource-manager",

articles/azure-resource-manager/bicep/bicep-mcp-server.md

@@ -0,0 +1,65 @@
+---
+title: Bicep MCP server
+description: Learn how to use Bicep MCP server to create Bicep files.
+ms.topic: how-to
+ms.date: 02/04/2026
+---
+
+# Use Bicep MCP server
+
+The Bicep MCP (Model Context Protocol) server provides AI agents with tools to help generate high-quality Bicep code. The current release exposes the following tools:
+
+* **`decompile_arm_parameters_file`** - Converts ARM template parameter JSON files into Bicep parameters format (.bicepparam).
+* **`decompile_arm_template_file`** - Converts ARM template JSON files into Bicep syntax (.bicep).
+* **`format_bicep_file`** - Applies consistent formatting, including indentation, spacing, and line breaks, to Bicep files.
+* **`get_az_resource_type_schema`** - Gets the schema for a specific Azure resource type and API version.
+* **`get_bicep_best_practices`** - Returns Bicep coding best practices and guidelines.
+* **`get_bicep_file_diagnostics`** - Analyzes a Bicep file and returns all compilation diagnostics.
+* **`get_deployment_snapshot`** - Creates a snapshot from a .bicepparam file to preview resources and compare Bicep implementations.
+* **`get_file_references`** - Analyzes a Bicep file and returns a list of all referenced files, including modules, parameter files, and other dependencies.
+* **`list_avm_metadata`** - Lists metadata for all Azure Verified Modules (AVM).
+* **`list_az_resource_types_for_provider`** - Lists all Azure resource types for a specific provider, such as Microsoft.Storage.
+
+Use the Bicep MCP server directly in [Visual Studio Code](#visual-studio-code). You can also run it locally with [MCP-compatible services](#integration-with-other-ai-services).
+
+## Limitations
+
+> [!NOTE]
+> You're responsible for reviewing all code generated by an LLM and **deploy at your own risk**.
+
+These tools provide additional context to help the chosen model generate semantically and syntactically correct Bicep code. These tools aren't designed to deploy directly to Azure.
+
+There's no way to definitively guarantee whether the agent orchestrator uses any particular Bicep tool. As a workaround, you can view the available Bicep tools and use specific prompting to guide the agent orchestrator to invoke a tool, such as "Create a Bicep file to do X using Bicep best practices."
+
+## Visual Studio Code
+
+The Bicep MCP server is available starting with Visual Studio Code Bicep extension version 0.40.2. For more information about installing, managing, and using Bicep MCP server from VS Code, see [Bicep MCP server](./visual-studio-code.md#bicep-mcp-server).
+
+## Integration with other AI services
+
+You can run the Azure Bicep MCP server locally for Claude Desktop and Code, OpenAI Codex CLI, and LMStudio where you can use it with various models.
+
+By using [.NET 10.0 SDK](https://dotnet.microsoft.com/download/dotnet/10.0?WT.mc_id=MVP_323261), you can use `dnx` to get the latest version of the Bicep MCP server directly from the NuGet package without needing to build it yourself.
+
+```
+dnx -y Azure.Bicep.McpServer
+```
+
+The following JSON is an example of configuration for Visual Studio Code:
+
+```json
+"Bicep": {
+  "type": "stdio",
+  "command": "dnx",
+  "args": [
+    "-y",
+    "Azure.Bicep.McpServer"
+  ]
+}
+```
+
+For more information, see [Configuration format](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_configuration-format).
+
+## Next steps
+
+For a tutorial on how to apply the information in this article, see [Quickstart: Create Bicep files with Visual Studio Code and Bicep MCP server](./quickstart-create-bicep-use-visual-studio-code-model-context-protocol.md).

…-resource-manager/bicep/deploy-vscode.md …nager/bicep/deploy-visual-studio-code.mdarticles/azure-resource-manager/bicep/deploy-vscode.md renamed to articles/azure-resource-manager/bicep/deploy-visual-studio-code.md articles/azure-resource-manager/bicep/deploy-vscode.md renamed to articles/azure-resource-manager/bicep/deploy-visual-studio-code.md

@@ -21,36 +21,36 @@ To use the deployment pane:
 
     - Select the show deployment pane button on the upper right corner as shown in the following screenshot:  
 
-        :::image type="content" source="./media/deploy-vscode/visual-studio-code-open-deployment-pane.png" alt-text="Screenshot of the open deployment pane button.":::
+        :::image type="content" source="./media/deploy-visual-studio-code/visual-studio-code-open-deployment-pane.png" alt-text="Screenshot of the open deployment pane button.":::
 
         By default, VS Code opens the deployment pane on the side. To open it in a new tab, hold <kbd>Alt</kbd> while selecting the button.
 
     - Another way to open the deployment pane is through the command palette. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, then select either **Show Deployment Pane** or **Show Deployment Pane to the Side**.
 
-        :::image type="content" source="./media/deploy-vscode/visual-studio-code-show-deployment-pane.png" alt-text="Screenshot of show deployment pane in command palette.":::
+        :::image type="content" source="./media/deploy-visual-studio-code/visual-studio-code-show-deployment-pane.png" alt-text="Screenshot of show deployment pane in command palette.":::
 
     The deployment pane appears as shown in the following screenshot:
 
-    :::image type="content" source="./media/deploy-vscode/visual-studio-code-deployment-pane.png" alt-text="Screenshot of initial deployment pane in Visual Studio Code.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/visual-studio-code-deployment-pane.png" alt-text="Screenshot of initial deployment pane in Visual Studio Code.":::
 
 1. Select **Pick Scope** to define the deployment scope. After authentication, you're able to select the subscription and the resource group of your desired deployment.
 1. If the deployment pane was opened for a .bicep file, fill out your desired parameter values, or select **Pick JSON Parameters File** to select a JSON parameter file.
 
-    :::image type="content" source="./media/deploy-vscode/visual-studio-code-deployment-pane-pick-parameters-file.png" alt-text="Screenshot of picking parameters file in the deployment pane in Visual Studio Code.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/visual-studio-code-deployment-pane-pick-parameters-file.png" alt-text="Screenshot of picking parameters file in the deployment pane in Visual Studio Code.":::
 
 1. Select your desired action - **Deploy**, **Validate**, or **What-if**.  
 
     - **Deploy**: deploys to Azure, and the result including the defined output are shown in the deployment pane.
 
       The following screenshot shows a successful deployment. You can select the blue globe icon to view the deployment or individual resources in the Azure portal.
 
-      :::image type="content" source="./media/deploy-vscode/visual-studio-code-deployment-pane-successful-deployment.png" alt-text="Screenshot of deployment pane in Visual Studio Code.":::
+      :::image type="content" source="./media/deploy-visual-studio-code/visual-studio-code-deployment-pane-successful-deployment.png" alt-text="Screenshot of deployment pane in Visual Studio Code.":::
 
     - **Validate**: performs a runtime validation of the Bicep file against Azure, ensuring that the resources, parameters, and policies are correct in the actual deployment environment. Unlike a [linter](./linter.md), which only performs offline validation, this validation interacts with Azure to detect potential deployment issues.
 
       The following screenshot shows an example of a validation failure.
 
-      :::image type="content" source="./media/deploy-vscode/visual-studio-code-deployment-pane-validation-error.png" alt-text="Screenshot of deployment pane validation error in Visual Studio Code.":::
+      :::image type="content" source="./media/deploy-visual-studio-code/visual-studio-code-deployment-pane-validation-error.png" alt-text="Screenshot of deployment pane validation error in Visual Studio Code.":::
 
     - **What-if**: executes a **What-If** analysis directly from the deployment pane. The pane displays the results, showing any planned changes. This performs the same function as the what-if command in Azure PowerShell and Azure CLI. For more information, see [Bicep deployment what-if operation](./deploy-what-if.md)
 
@@ -64,35 +64,35 @@ There are three ways you can find the command from an open Bicep file in Visual
 
 - Right-click the Bicep file name from the Explorer pane instead of the one under **OPEN EDITORS**:
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-from-explorer.png" alt-text="Screenshot of Deploying Bicep File in the Context menu from the explorer pane.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/bicep-deploy-from-explorer.png" alt-text="Screenshot of Deploying Bicep File in the Context menu from the explorer pane.":::
 
 - Right-click anywhere inside a Bicep file, and then select **Deploy Bicep File**.
 
 - Select **Command Palette** from the **View** menu, and then select **Bicep: Deploy Bicep File**.
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-from-command-palette.png" alt-text="Screenshot of Deploy Bicep File in the Context menu.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/bicep-deploy-from-command-palette.png" alt-text="Screenshot of Deploy Bicep File in the Context menu.":::
 
 After you select the command, follow the wizard to enter the values:
 
 1. If you're not signed in, follow the instructions provided in the prompt to complete the sign-in process.
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-sign-in.png" alt-text="Screenshot of sign-in.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/bicep-deploy-sign-in.png" alt-text="Screenshot of sign-in.":::
 
     [!INCLUDE [vscode authentication](../../../includes/resource-manager-vscode-authentication.md)]
 
 1. Select or create a resource group.
 
 1. Select a parameters file or **None** to enter values for parameters:
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-select-parameter-file.png" alt-text="Screenshot of Select parameters file.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/bicep-deploy-select-parameter-file.png" alt-text="Screenshot of Select parameters file.":::
 
 1. If you choose **None**, enter the values for parameters:
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-enter-parameter-values.png" alt-text="Screenshot of Enter parameter values.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/bicep-deploy-enter-parameter-values.png" alt-text="Screenshot of Enter parameter values.":::
 
     After you enter the values, you have the option to create a parameters file from values used in this deployment:
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-create-parameter-file.png" alt-text="Screenshot of Create parameters file.":::
+    :::image type="content" source="./media/deploy-visual-studio-code/bicep-deploy-create-parameter-file.png" alt-text="Screenshot of Create parameters file.":::
 
     If you select **Yes**, a parameters file named _&lt;Bicep-file-name>.parameters.json_ is created in the same folder.
 

articles/azure-resource-manager/bicep/deploy-what-if.md

@@ -15,7 +15,7 @@ ms.custom:
 
 Before deploying a Bicep file, you can preview the changes that will happen. Azure Resource Manager provides the what-if operation to let you see how resources will change if you deploy the Bicep file. The what-if operation doesn't make any changes to existing resources. Instead, it predicts the changes if the specified Bicep file is deployed.
 
-You can use the what-if operation with [Visual Studio Code](./deploy-vscode.md#deployment-pane), Azure PowerShell, Azure CLI, or REST API operations. What-if is supported for resource group, subscription, management group, and tenant level deployments.
+You can use the what-if operation with [Visual Studio Code](./deploy-visual-studio-code.md#deployment-pane), Azure PowerShell, Azure CLI, or REST API operations. What-if is supported for resource group, subscription, management group, and tenant level deployments.
 
 During What-If operations, the evaluation and expansion of `templateLink` aren't supported. As a result, any resources deployed using template links within nested deployments, including template spec references, won't be visible in the What-If operation results.