chore: updated readme with toolMetadataOverrides

Author: himanshusinghs

README.md

@@ -368,6 +368,7 @@ The MongoDB MCP Server can be configured using multiple methods, with the follow
 | `previewFeatures`                      | `MDB_MCP_PREVIEW_FEATURES`                          | `""`                                                                                                   | Comma separated values of preview features that are enabled.                                                                                                                                    |
 | `readOnly`                             | `MDB_MCP_READ_ONLY`                                 | `false`                                                                                                | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations.                                                                           |
 | `telemetry`                            | `MDB_MCP_TELEMETRY`                                 | `"enabled"`                                                                                            | When set to disabled, disables telemetry collection.                                                                                                                                            |
+| `toolMetadataOverrides`                | `MDB_MCP_TOOL_METADATA_OVERRIDES`                   | `"{}"`                                                                                                 | A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool. Example: `{ "toolMetadataOverrides": { "find": { "name": "query" } } }`                       |
 | `transport`                            | `MDB_MCP_TRANSPORT`                                 | `"stdio"`                                                                                              | Either 'stdio' or 'http'.                                                                                                                                                                       |
 | `voyageApiKey`                         | `MDB_MCP_VOYAGE_API_KEY`                            | `""`                                                                                                   | API key for Voyage AI embeddings service (required for vector search operations with text-to-embedding conversion).                                                                             |
 

scripts/generateArguments.ts

@@ -275,6 +275,10 @@ function generateReadmeConfigTable(argumentInfos: ArgumentInfo[]): string {
                     case "string":
                         defaultValueString = `\`"${defaultValue}"\``;
                         break;
+                    case "object": {
+                        defaultValueString = `\`"${JSON.stringify(defaultValue)}"\``;
+                        break;
+                    }
                     default:
                         throw new Error(`Unsupported default value type: ${typeof defaultValue}`);
                 }

server.json

@@ -170,6 +170,13 @@
           "format": "string",
           "isSecret": false
         },
+        {
+          "name": "MDB_MCP_TOOL_METADATA_OVERRIDES",
+          "description": "A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool. Example: `{ \"toolMetadataOverrides\": { \"find\": { \"name\": \"query\" } } }`",
+          "isRequired": false,
+          "format": "string",
+          "isSecret": false
+        },
         {
           "name": "MDB_MCP_TRANSPORT",
           "description": "Either 'stdio' or 'http'.",
@@ -323,6 +330,12 @@
           "description": "When set to disabled, disables telemetry collection.",
           "isRequired": false
         },
+        {
+          "type": "named",
+          "name": "--toolMetadataOverrides",
+          "description": "A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool. Example: `{ \"toolMetadataOverrides\": { \"find\": { \"name\": \"query\" } } }`",
+          "isRequired": false
+        },
         {
           "type": "named",
           "name": "--transport",
@@ -498,6 +511,13 @@
           "format": "string",
           "isSecret": false
         },
+        {
+          "name": "MDB_MCP_TOOL_METADATA_OVERRIDES",
+          "description": "A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool. Example: `{ \"toolMetadataOverrides\": { \"find\": { \"name\": \"query\" } } }`",
+          "isRequired": false,
+          "format": "string",
+          "isSecret": false
+        },
         {
           "name": "MDB_MCP_TRANSPORT",
           "description": "Either 'stdio' or 'http'.",
@@ -651,6 +671,12 @@
           "description": "When set to disabled, disables telemetry collection.",
           "isRequired": false
         },
+        {
+          "type": "named",
+          "name": "--toolMetadataOverrides",
+          "description": "A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool. Example: `{ \"toolMetadataOverrides\": { \"find\": { \"name\": \"query\" } } }`",
+          "isRequired": false
+        },
         {
           "type": "named",
           "name": "--transport",

src/common/config/userConfig.ts

@@ -176,5 +176,7 @@ export const UserConfigSchema = z4.object({
             })
         )
         .default({})
-        .describe("A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool."),
+        .describe(
+            'A map of name of the MongoDB MCP server tool to the metadata that needs to be used for that tool. Example: `{ "toolMetadataOverrides": { "find": { "name": "query" } } }`'
+        ),
 });