Skip to content

Commit d462ff9

Browse files
Improve Azure Deployment README for clarity and completeness (#726)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent ecbcfa6 commit d462ff9

File tree

4 files changed

+23
-10
lines changed

4 files changed

+23
-10
lines changed

deploy/azure/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This directory contains an Azure Bicep template (`bicep/main.bicep`) and support
88

99
- Azure CLI (2.55.0 or later) installed and signed in (`az login`).
1010
- Azure subscription with permissions to deploy the required resources.
11-
- MongoDB MCP server container image available in dockerhub registry (mongodb/mongodb-mcp-server:latest).
11+
- MongoDB MCP server container image available in dockerhub registry (mongodb/mongodb-mcp-server:1.2.0). Version 1.2.0 has been validated for Azure AI Foundry compatibility when the aggregate, create-index, explain, and export tools are omitted (additional tools are disabled by default for security). You can reference the `latest` tag instead if you want to experiment with newer builds.
1212

1313
## Parameter Files
1414

@@ -19,6 +19,17 @@ Two sample parameter files are provided to help you tailor deployments:
1919

2020
> **Tip:** Update the image reference, secrets, networking, and any other environment-specific values in the chosen parameter file before deployment.
2121
22+
### Managed Identity Authentication Parameters
23+
24+
When using `bicep/paramsWithAuthEnabled.json`, provide tenant and app-specific values for the following parameters before deployment:
25+
26+
- `authClientId`: Set to the application (client) ID of the Microsoft Entra ID app registration that represents the MongoDB MCP server API (often the managed identity or a server-side app registration).
27+
- `authIssuerUrl`: Use the issuer URL for your tenant. Use `<authentication-endpoint>/<TENANT-ID>/v2.0`, and replace <authentication-endpoint> with the authentication endpoint for your cloud environment (for example, "https://login.microsoftonline.com" for global Azure), also replacing <TENANT-ID> with the Directory (tenant) ID in which the app registration was created.
28+
- `authTenantId`: The tenant ID (directory ID) of the Microsoft Entra tenant that owns the identities interacting with the MCP server. Obtain it via `az account show --query tenantId -o tsv`.
29+
- `authAllowedClientApps` (optional): Provide an array of application (client) IDs for every client that should be allowed to request tokens for the MongoDB MCP server (for example, front-end apps, automation scripts, or integration partners). Omit this property to allow all clients without any filtering.
30+
31+
For deeper guidance on Microsoft Entra authentication in Azure Container Apps, see the official docs: <https://learn.microsoft.com/en-us/azure/container-apps/authentication-entra>.
32+
2233
## Deploy the Bicep Template
2334

2435
1. **Set common variables (PowerShell example):**
@@ -54,6 +65,8 @@ Two sample parameter files are provided to help you tailor deployments:
5465
--parameters @$parameterFile
5566
```
5667

68+
If the deployment returns an error, rerun the command with `--debug` to surface detailed troubleshooting output.
69+
5770
5. **Monitor outputs:** Review the deployment outputs and logs for connection endpoints, credential references, or other values needed to complete integration.
5871

5972
## Post-Deployment Checklist

deploy/azure/bicep/main.bicep

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ param location string = resourceGroup().location
88
param containerAppName string = 'mongo-mcp-server-app'
99

1010
@description('Docker image to deploy')
11-
param containerImage string = 'mongodb/mongodb-mcp-server:latest'
11+
param containerImage string = 'mongodb/mongodb-mcp-server:1.2.0'
1212

1313
@description('Container CPU (vCPU) as string. Allowed: 0.25 - 2.0 in 0.25 increments')
1414
@allowed([

deploy/azure/bicep/params.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"contentVersion": "1.0.0.0",
44
"parameters": {
55
"containerAppEnvName": { "value": "container-app-env" },
6-
"containerAppName": { "value": "mongo-mcp-server-app-without-auth" },
7-
"containerImage": { "value": "mongodb/mongodb-mcp-server:latest" },
6+
"containerAppName": { "value": "mongo-mcp-without-auth" },
7+
"containerImage": { "value": "mongodb/mongodb-mcp-server:1.2.0" },
88
"containerCpu": { "value": "1.0" },
99
"containerMemory": { "value": "2Gi" },
1010
"appEnvironmentVars": {
@@ -15,10 +15,10 @@
1515
"MDB_MCP_TRANSPORT": "http",
1616
"MDB_MCP_LOGGERS": "disk,mcp,stderr",
1717
"MDB_MCP_LOG_PATH": "/tmp/mongodb-mcp",
18-
"MDB_MCP_DISABLED_TOOLS": "explain,export,atlas-create-access-list,atlas-create-db-user,drop-database,drop-collection,delete-many"
18+
"MDB_MCP_DISABLED_TOOLS": "aggregate,create-index,explain,export,atlas-create-access-list,atlas-create-db-user,drop-database,drop-collection,delete-many"
1919
}
2020
},
21-
"authMode": { "value": "NOAUTH" },
22-
"mdbConnectionString": { "value": "<MONGODB_CONNECTION_STRING>" }
21+
"mdbConnectionString": { "value": "<MONGODB_CONNECTION_STRING>" },
22+
"authMode": { "value": "NOAUTH" }
2323
}
2424
}

deploy/azure/bicep/paramsWithAuthEnabled.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"contentVersion": "1.0.0.0",
44
"parameters": {
55
"containerAppEnvName": { "value": "container-app-env" },
6-
"containerAppName": { "value": "mongo-mcp-server-app-with-auth" },
7-
"containerImage": { "value": "mongodb/mongodb-mcp-server:latest" },
6+
"containerAppName": { "value": "mongo-mcp-with-auth" },
7+
"containerImage": { "value": "mongodb/mongodb-mcp-server:1.2.0" },
88
"containerCpu": { "value": "1.0" },
99
"containerMemory": { "value": "2Gi" },
1010
"appEnvironmentVars": {
@@ -15,7 +15,7 @@
1515
"MDB_MCP_TRANSPORT": "http",
1616
"MDB_MCP_LOGGERS": "disk,mcp,stderr",
1717
"MDB_MCP_LOG_PATH": "/tmp/mongodb-mcp",
18-
"MDB_MCP_DISABLED_TOOLS": "explain,export,atlas-create-access-list,atlas-create-db-user,drop-database,drop-collection,delete-many"
18+
"MDB_MCP_DISABLED_TOOLS": "aggregate,create-index,explain,export,atlas-create-access-list,atlas-create-db-user,drop-database,drop-collection,delete-many"
1919
}
2020
},
2121
"mdbConnectionString": { "value": "<MONGODB_CONNECTION_STRING>" },

0 commit comments

Comments
 (0)