From b57ac39662457af8fddaaad2417fd6161bdb2073 Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Thu, 21 Aug 2025 16:27:08 +0200 Subject: [PATCH 1/5] chore: adds config options relevant for MCP server --- package.json | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/package.json b/package.json index b9c2d85fd..ff554698f 100644 --- a/package.json +++ b/package.json @@ -1282,6 +1282,46 @@ "type": "boolean", "default": true, "description": "Specify whether to show the overview page immediately after installing the extension." + }, + "mdb.mcp.apiBaseUrl": { + "type": "string", + "default": "https://cloud.mongodb.com/", + "description": "Atlas API URL. Required for running Atlas tools." + }, + "mdb.mcp.apiClientId": { + "type": "string", + "default": "", + "description": "Atlas API client ID for authentication. Required for running Atlas tools." + }, + "mdb.mcp.apiClientSecret": { + "type": "string", + "default": "", + "description": "Atlas API client secret for authentication. Required for running Atlas tools." + }, + "mdb.mcp.disabledTools": { + "type": "array", + "default": [], + "description": "An array of tool names, operation types, and/or categories of tools that will be disabled." + }, + "mdb.mcp.readOnly": { + "type": "boolean", + "default": false, + "description": "When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations." + }, + "mdb.mcp.indexCheck": { + "type": "boolean", + "default": false, + "description": "When set to true, enforces that query operations must use an index, rejecting queries that perform a collection scan." + }, + "mdb.mcp.server": { + "type": "string", + "enum": [ + "enabled", + "disabled", + "ask" + ], + "default": "ask", + "description": "Controls whether MCP server starts automatically or only when permitted." } } }, From d151bd11155734c24af6189f46b5619713e9acdf Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Fri, 22 Aug 2025 14:54:40 +0200 Subject: [PATCH 2/5] chore: few more relevant mcp configurations exposed --- package.json | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index ff554698f..8267727cd 100644 --- a/package.json +++ b/package.json @@ -1286,7 +1286,7 @@ "mdb.mcp.apiBaseUrl": { "type": "string", "default": "https://cloud.mongodb.com/", - "description": "Atlas API URL. Required for running Atlas tools." + "description": "API URL of MongoDB Atlas. Required for running Atlas tools." }, "mdb.mcp.apiClientId": { "type": "string", @@ -1300,6 +1300,9 @@ }, "mdb.mcp.disabledTools": { "type": "array", + "items": { + "type": "string" + }, "default": [], "description": "An array of tool names, operation types, and/or categories of tools that will be disabled." }, @@ -1322,6 +1325,48 @@ ], "default": "ask", "description": "Controls whether MCP server starts automatically or only when permitted." + }, + "mdb.mcp.telemetry": { + "type": "boolean", + "default": true, + "description": "Allow the builtin MongoDB MCP server to collect anonymous diagnostic and usage telemetry data." + }, + "mdb.mcp.exportsPath": { + "type": "string", + "default": "", + "description": "The directory where the export tool will export the data to. Leave it empty to use the default path." + }, + "mdb.mcp.exportTimeoutMs": { + "type": "number", + "default": 300000, + "description": "The time in milliseconds after which an export will expire." + }, + "mdb.mcp.exportCleanupIntervalMs": { + "type": "number", + "default": 120000, + "description": "The time in milliseconds that controls how often export clean up should run." + }, + "mdb.mcp.loggers": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "mcp", + "disk", + "stderr" + ] + }, + "uniqueItems": true, + "default": [ + "mcp", + "disk" + ], + "description": "Controls which loggers the MCP server will use for diagnostic logging." + }, + "mdb.mcp.logPath": { + "type": "string", + "default": "", + "description": "The directory where the disk logger, when selected, will write the logs to. Leave it empty to use the default path." } } }, From ddae6ca7e346f00eb16a812759b4c16d13a00b6f Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Fri, 22 Aug 2025 15:03:07 +0200 Subject: [PATCH 3/5] chore: minor wording updates --- package.json | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/package.json b/package.json index 8267727cd..991bae258 100644 --- a/package.json +++ b/package.json @@ -1304,7 +1304,7 @@ "type": "string" }, "default": [], - "description": "An array of tool names, operation types, and/or categories of tools that will be disabled." + "description": "Tool names, operation types (create, update, delete, read, metadata, connect), and/or categories (atlas, mongodb) to disable." }, "mdb.mcp.readOnly": { "type": "boolean", @@ -1327,14 +1327,18 @@ "description": "Controls whether MCP server starts automatically or only when permitted." }, "mdb.mcp.telemetry": { - "type": "boolean", - "default": true, - "description": "Allow the builtin MongoDB MCP server to collect anonymous diagnostic and usage telemetry data." + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "default": "enabled", + "description": "Controls whether telemetry collection by the MCP server is enabled or disabled." }, "mdb.mcp.exportsPath": { "type": "string", "default": "", - "description": "The directory where the export tool will export the data to. Leave it empty to use the default path." + "description": "The directory where the export tool will export data. Leave empty to use the default path." }, "mdb.mcp.exportTimeoutMs": { "type": "number", @@ -1344,29 +1348,29 @@ "mdb.mcp.exportCleanupIntervalMs": { "type": "number", "default": 120000, - "description": "The time in milliseconds that controls how often export clean up should run." + "description": "Controls how often the export cleanup process runs to remove expired files (in milliseconds)." }, "mdb.mcp.loggers": { "type": "array", "items": { "type": "string", "enum": [ - "mcp", "disk", + "mcp", "stderr" ] }, "uniqueItems": true, "default": [ - "mcp", - "disk" + "disk", + "mcp" ], "description": "Controls which loggers the MCP server will use for diagnostic logging." }, "mdb.mcp.logPath": { "type": "string", "default": "", - "description": "The directory where the disk logger, when selected, will write the logs to. Leave it empty to use the default path." + "description": "The directory where log files will be written when disk logging is enabled. Leave empty to use the default path." } } }, From 246ab51abd9efd35e6e272a99e1ea6f69b909b20 Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Fri, 22 Aug 2025 17:59:26 +0200 Subject: [PATCH 4/5] chore: clarify the descriptions a bit more and remove double telemetry config --- package.json | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/package.json b/package.json index 991bae258..6035fd7d8 100644 --- a/package.json +++ b/package.json @@ -1286,17 +1286,17 @@ "mdb.mcp.apiBaseUrl": { "type": "string", "default": "https://cloud.mongodb.com/", - "description": "API URL of MongoDB Atlas. Required for running Atlas tools." + "description": "API URL of MongoDB Atlas to be used by MongoDB MCP server for enabling Atlas tools. When empty, it defaults to 'https://cloud.mongodb.com/'." }, "mdb.mcp.apiClientId": { "type": "string", "default": "", - "description": "Atlas API client ID for authentication. Required for running Atlas tools." + "description": "Atlas API client ID, to be used by MongoDB MCP server, preferably for a Service Account (https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization), for authentication. Required for running Atlas tools." }, "mdb.mcp.apiClientSecret": { "type": "string", "default": "", - "description": "Atlas API client secret for authentication. Required for running Atlas tools." + "description": "Atlas API client secret, to be used by MongoDB MCP server, preferably through a Service Account (https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization), for authentication. Required for running Atlas tools." }, "mdb.mcp.disabledTools": { "type": "array", @@ -1304,17 +1304,17 @@ "type": "string" }, "default": [], - "description": "Tool names, operation types (create, update, delete, read, metadata, connect), and/or categories (atlas, mongodb) to disable." + "description": "Tool names, operation types (create, update, delete, read, metadata), and/or categories (atlas, mongodb) to disable in MongoDB MCP server." }, "mdb.mcp.readOnly": { "type": "boolean", "default": false, - "description": "When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations." + "description": "When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations in MongoDB MCP server." }, "mdb.mcp.indexCheck": { "type": "boolean", "default": false, - "description": "When set to true, enforces that query operations must use an index, rejecting queries that perform a collection scan." + "description": "When set to true, enforces that query operations must use an index, rejecting queries that perform a collection scan in MongoDB MCP server." }, "mdb.mcp.server": { "type": "string", @@ -1324,31 +1324,22 @@ "ask" ], "default": "ask", - "description": "Controls whether MCP server starts automatically or only when permitted." - }, - "mdb.mcp.telemetry": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ], - "default": "enabled", - "description": "Controls whether telemetry collection by the MCP server is enabled or disabled." + "description": "Controls whether MongoDB MCP server starts automatically with the extension or if a permission is requested when connecting to a new connection. If automatic startup is disabled, the server can still be started using the 'MongoDB: Start MCP Server' command." }, "mdb.mcp.exportsPath": { "type": "string", "default": "", - "description": "The directory where the export tool will export data. Leave empty to use the default path." + "description": "The directory where the export tool from MongoDB MCP server will export data. Leave empty to use the default path." }, "mdb.mcp.exportTimeoutMs": { "type": "number", "default": 300000, - "description": "The time in milliseconds after which an export will expire." + "description": "The time in milliseconds after which the MongoDB MCP server will expire the export." }, "mdb.mcp.exportCleanupIntervalMs": { "type": "number", "default": 120000, - "description": "Controls how often the export cleanup process runs to remove expired files (in milliseconds)." + "description": "Controls how often the MongoDB MCP server runs the export cleanup process to remove expired files (in milliseconds)." }, "mdb.mcp.loggers": { "type": "array", @@ -1365,12 +1356,12 @@ "disk", "mcp" ], - "description": "Controls which loggers the MCP server will use for diagnostic logging." + "description": "Controls which loggers the MongoDB MCP server will use for diagnostic logging." }, "mdb.mcp.logPath": { "type": "string", "default": "", - "description": "The directory where log files will be written when disk logging is enabled. Leave empty to use the default path." + "description": "The directory where MongoDB MCP server will write the log files when disk logging is enabled. Leave empty to use the default path." } } }, From d8e6625a00c86ac77feebbbdefdc1087667f57dd Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Fri, 22 Aug 2025 18:15:15 +0200 Subject: [PATCH 5/5] chore: added clarification for new settings being related to MongoDB MCP server and few more PR suggesions --- package.json | 38 ++++++++------------------------------ 1 file changed, 8 insertions(+), 30 deletions(-) diff --git a/package.json b/package.json index 6035fd7d8..1f2df2be4 100644 --- a/package.json +++ b/package.json @@ -1286,17 +1286,17 @@ "mdb.mcp.apiBaseUrl": { "type": "string", "default": "https://cloud.mongodb.com/", - "description": "API URL of MongoDB Atlas to be used by MongoDB MCP server for enabling Atlas tools. When empty, it defaults to 'https://cloud.mongodb.com/'." + "description": "API URL of MongoDB Atlas to be used by MongoDB MCP server for enabling Atlas tools. When empty, it defaults to 'https://cloud.mongodb.com/'. Only change this if you're using a custom Atlas deployment." }, "mdb.mcp.apiClientId": { "type": "string", "default": "", - "description": "Atlas API client ID, to be used by MongoDB MCP server, preferably for a Service Account (https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization), for authentication. Required for running Atlas tools." + "description": "Atlas API client ID for authenticating against Atlas API. Use a Service Account (https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization) for programmatic access to Atlas APIs. Required for enabling Atlas tools in MongoDB MCP server. Store this securely and do not commit to version control." }, "mdb.mcp.apiClientSecret": { "type": "string", "default": "", - "description": "Atlas API client secret, to be used by MongoDB MCP server, preferably through a Service Account (https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization), for authentication. Required for running Atlas tools." + "description": "Atlas API client secret for authenticating against Atlas API. Use a Service Account (https://www.mongodb.com/docs/atlas/configure-api-access/#grant-programmatic-access-to-an-organization) for programmatic access to Atlas APIs. Required for enabling Atlas tools in MongoDB MCP server. Store this securely and do not commit to version control." }, "mdb.mcp.disabledTools": { "type": "array", @@ -1309,12 +1309,12 @@ "mdb.mcp.readOnly": { "type": "boolean", "default": false, - "description": "When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations in MongoDB MCP server." + "description": "When set to true, MongoDB MCP server will only allow read, connect, and metadata operation types, disabling create/update/delete operations." }, "mdb.mcp.indexCheck": { "type": "boolean", "default": false, - "description": "When set to true, enforces that query operations must use an index, rejecting queries that perform a collection scan in MongoDB MCP server." + "description": "When set to true, MongoDB MCP server enforces that query operations must use an index, rejecting queries that perform a collection scan. This helps prevent performance issues in production environments." }, "mdb.mcp.server": { "type": "string", @@ -1329,39 +1329,17 @@ "mdb.mcp.exportsPath": { "type": "string", "default": "", - "description": "The directory where the export tool from MongoDB MCP server will export data. Leave empty to use the default path." + "description": "The directory where the MongoDB MCP server will export the data to when using the export tool. Ensure the path is writable or leave empty to use the default path." }, "mdb.mcp.exportTimeoutMs": { "type": "number", "default": 300000, - "description": "The time in milliseconds after which the MongoDB MCP server will expire the export." + "description": "The time in milliseconds after which the MongoDB MCP server will expire the export. Default is 5 minutes (300000ms)." }, "mdb.mcp.exportCleanupIntervalMs": { "type": "number", "default": 120000, - "description": "Controls how often the MongoDB MCP server runs the export cleanup process to remove expired files (in milliseconds)." - }, - "mdb.mcp.loggers": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "disk", - "mcp", - "stderr" - ] - }, - "uniqueItems": true, - "default": [ - "disk", - "mcp" - ], - "description": "Controls which loggers the MongoDB MCP server will use for diagnostic logging." - }, - "mdb.mcp.logPath": { - "type": "string", - "default": "", - "description": "The directory where MongoDB MCP server will write the log files when disk logging is enabled. Leave empty to use the default path." + "description": "Controls how often the MongoDB MCP server runs the export cleanup process to remove expired files (in milliseconds). Default is 2 minutes (120000ms)." } } },