feat: respect toolMetadataOverrides for tools

himanshusinghs · himanshusinghs · commit 3b4c644285f6 · 2025-11-20T20:50:34.000+01:00
This commit ensures that we register the tool with correct metadata
, taking into consideration the toolMetadataOverrides provided by the
users.
diff --git a/src/tools/atlas/connect/connectCluster.ts b/src/tools/atlas/connect/connectCluster.ts
@@ -30,8 +30,8 @@ export const ConnectClusterArgs = {
 };
 
 export class ConnectClusterTool extends AtlasToolBase {
-    public name = "atlas-connect-cluster";
-    protected description = "Connect to MongoDB Atlas cluster";
+    public internalName = "atlas-connect-cluster";
+    protected internalDescription = "Connect to MongoDB Atlas cluster";
     public operationType: OperationType = "connect";
     protected argsShape = {
         ...ConnectClusterArgs,
diff --git a/src/tools/atlas/create/createAccessList.ts b/src/tools/atlas/create/createAccessList.ts
@@ -17,8 +17,8 @@ export const CreateAccessListArgs = {
 };
 
 export class CreateAccessListTool extends AtlasToolBase {
-    public name = "atlas-create-access-list";
-    protected description = "Allow Ip/CIDR ranges to access your MongoDB Atlas clusters.";
+    public internalName = "atlas-create-access-list";
+    protected internalDescription = "Allow Ip/CIDR ranges to access your MongoDB Atlas clusters.";
     public operationType: OperationType = "create";
     protected argsShape = {
         ...CreateAccessListArgs,
diff --git a/src/tools/atlas/create/createDBUser.ts b/src/tools/atlas/create/createDBUser.ts
@@ -34,8 +34,8 @@ export const CreateDBUserArgs = {
 };
 
 export class CreateDBUserTool extends AtlasToolBase {
-    public name = "atlas-create-db-user";
-    protected description = "Create an MongoDB Atlas database user";
+    public internalName = "atlas-create-db-user";
+    protected internalDescription = "Create an MongoDB Atlas database user";
     public operationType: OperationType = "create";
     protected argsShape = {
         ...CreateDBUserArgs,
diff --git a/src/tools/atlas/create/createFreeCluster.ts b/src/tools/atlas/create/createFreeCluster.ts
@@ -6,8 +6,8 @@ import { ensureCurrentIpInAccessList } from "../../../common/atlas/accessListUti
 import { AtlasArgs } from "../../args.js";
 
 export class CreateFreeClusterTool extends AtlasToolBase {
-    public name = "atlas-create-free-cluster";
-    protected description = "Create a free MongoDB Atlas cluster";
+    public internalName = "atlas-create-free-cluster";
+    protected internalDescription = "Create a free MongoDB Atlas cluster";
     public operationType: OperationType = "create";
     protected argsShape = {
         projectId: AtlasArgs.projectId().describe("Atlas project ID to create the cluster in"),
diff --git a/src/tools/atlas/create/createProject.ts b/src/tools/atlas/create/createProject.ts
@@ -5,8 +5,8 @@ import type { Group } from "../../../common/atlas/openapi.js";
 import { AtlasArgs } from "../../args.js";
 
 export class CreateProjectTool extends AtlasToolBase {
-    public name = "atlas-create-project";
-    protected description = "Create a MongoDB Atlas project";
+    public internalName = "atlas-create-project";
+    protected internalDescription = "Create a MongoDB Atlas project";
     public operationType: OperationType = "create";
     protected argsShape = {
         projectName: AtlasArgs.projectName().optional().describe("Name for the new project"),
diff --git a/src/tools/atlas/read/getPerformanceAdvisor.ts b/src/tools/atlas/read/getPerformanceAdvisor.ts
@@ -24,8 +24,8 @@ const PerformanceAdvisorOperationType = z.enum([
 ]);
 
 export class GetPerformanceAdvisorTool extends AtlasToolBase {
-    public name = "atlas-get-performance-advisor";
-    protected description = `Get MongoDB Atlas performance advisor recommendations, which includes the operations: suggested indexes, drop index suggestions, schema suggestions, and a sample of the most recent (max ${DEFAULT_SLOW_QUERY_LOGS_LIMIT}) slow query logs`;
+    public internalName = "atlas-get-performance-advisor";
+    protected internalDescription = `Get MongoDB Atlas performance advisor recommendations, which includes the operations: suggested indexes, drop index suggestions, schema suggestions, and a sample of the most recent (max ${DEFAULT_SLOW_QUERY_LOGS_LIMIT}) slow query logs`;
     public operationType: OperationType = "read";
     protected argsShape = {
         projectId: AtlasArgs.projectId().describe(
diff --git a/src/tools/atlas/read/inspectAccessList.ts b/src/tools/atlas/read/inspectAccessList.ts
@@ -8,8 +8,8 @@ export const InspectAccessListArgs = {
 };
 
 export class InspectAccessListTool extends AtlasToolBase {
-    public name = "atlas-inspect-access-list";
-    protected description = "Inspect Ip/CIDR ranges with access to your MongoDB Atlas clusters.";
+    public internalName = "atlas-inspect-access-list";
+    protected internalDescription = "Inspect Ip/CIDR ranges with access to your MongoDB Atlas clusters.";
     public operationType: OperationType = "read";
     protected argsShape = {
         ...InspectAccessListArgs,
diff --git a/src/tools/atlas/read/inspectCluster.ts b/src/tools/atlas/read/inspectCluster.ts
@@ -11,8 +11,8 @@ export const InspectClusterArgs = {
 };
 
 export class InspectClusterTool extends AtlasToolBase {
-    public name = "atlas-inspect-cluster";
-    protected description = "Inspect MongoDB Atlas cluster";
+    public internalName = "atlas-inspect-cluster";
+    protected internalDescription = "Inspect MongoDB Atlas cluster";
     public operationType: OperationType = "read";
     protected argsShape = {
         ...InspectClusterArgs,
diff --git a/src/tools/atlas/read/listAlerts.ts b/src/tools/atlas/read/listAlerts.ts
@@ -8,8 +8,8 @@ export const ListAlertsArgs = {
 };
 
 export class ListAlertsTool extends AtlasToolBase {
-    public name = "atlas-list-alerts";
-    protected description = "List MongoDB Atlas alerts";
+    public internalName = "atlas-list-alerts";
+    protected internalDescription = "List MongoDB Atlas alerts";
     public operationType: OperationType = "read";
     protected argsShape = {
         ...ListAlertsArgs,
diff --git a/src/tools/atlas/read/listClusters.ts b/src/tools/atlas/read/listClusters.ts
@@ -16,8 +16,8 @@ export const ListClustersArgs = {
 };
 
 export class ListClustersTool extends AtlasToolBase {
-    public name = "atlas-list-clusters";
-    protected description = "List MongoDB Atlas clusters";
+    public internalName = "atlas-list-clusters";
+    protected internalDescription = "List MongoDB Atlas clusters";
     public operationType: OperationType = "read";
     protected argsShape = {
         ...ListClustersArgs,
diff --git a/src/tools/atlas/read/listDBUsers.ts b/src/tools/atlas/read/listDBUsers.ts
@@ -9,8 +9,8 @@ export const ListDBUsersArgs = {
 };
 
 export class ListDBUsersTool extends AtlasToolBase {
-    public name = "atlas-list-db-users";
-    protected description = "List MongoDB Atlas database users";
+    public internalName = "atlas-list-db-users";
+    protected internalDescription = "List MongoDB Atlas database users";
     public operationType: OperationType = "read";
     protected argsShape = {
         ...ListDBUsersArgs,
diff --git a/src/tools/atlas/read/listOrgs.ts b/src/tools/atlas/read/listOrgs.ts
@@ -4,8 +4,8 @@ import type { OperationType } from "../../tool.js";
 import { formatUntrustedData } from "../../tool.js";
 
 export class ListOrganizationsTool extends AtlasToolBase {
-    public name = "atlas-list-orgs";
-    protected description = "List MongoDB Atlas organizations";
+    public internalName = "atlas-list-orgs";
+    protected internalDescription = "List MongoDB Atlas organizations";
     public operationType: OperationType = "read";
     protected argsShape = {};
 
diff --git a/src/tools/atlas/read/listProjects.ts b/src/tools/atlas/read/listProjects.ts
@@ -6,8 +6,8 @@ import type { ToolArgs } from "../../tool.js";
 import { AtlasArgs } from "../../args.js";
 
 export class ListProjectsTool extends AtlasToolBase {
-    public name = "atlas-list-projects";
-    protected description = "List MongoDB Atlas projects";
+    public internalName = "atlas-list-projects";
+    protected internalDescription = "List MongoDB Atlas projects";
     public operationType: OperationType = "read";
     protected argsShape = {
         orgId: AtlasArgs.organizationId()
diff --git a/src/tools/atlasLocal/connect/connectDeployment.ts b/src/tools/atlasLocal/connect/connectDeployment.ts
@@ -6,8 +6,8 @@ import { CommonArgs } from "../../args.js";
 import type { ConnectionMetadata } from "../../../telemetry/types.js";
 
 export class ConnectDeploymentTool extends AtlasLocalToolBase {
-    public name = "atlas-local-connect-deployment";
-    protected description = "Connect to a MongoDB Atlas Local deployment";
+    public internalName = "atlas-local-connect-deployment";
+    protected internalDescription = "Connect to a MongoDB Atlas Local deployment";
     public operationType: OperationType = "connect";
     protected argsShape = {
         deploymentName: CommonArgs.string().describe("Name of the deployment to connect to"),
diff --git a/src/tools/atlasLocal/create/createDeployment.ts b/src/tools/atlasLocal/create/createDeployment.ts
@@ -5,8 +5,8 @@ import type { Client, CreateDeploymentOptions } from "@mongodb-js/atlas-local";
 import { CommonArgs } from "../../args.js";
 
 export class CreateDeploymentTool extends AtlasLocalToolBase {
-    public name = "atlas-local-create-deployment";
-    protected description = "Create a MongoDB Atlas local deployment";
+    public internalName = "atlas-local-create-deployment";
+    protected internalDescription = "Create a MongoDB Atlas local deployment";
     public operationType: OperationType = "create";
     protected argsShape = {
         deploymentName: CommonArgs.string().describe("Name of the deployment to create").optional(),
diff --git a/src/tools/atlasLocal/delete/deleteDeployment.ts b/src/tools/atlasLocal/delete/deleteDeployment.ts
@@ -5,8 +5,8 @@ import type { Client } from "@mongodb-js/atlas-local";
 import { CommonArgs } from "../../args.js";
 
 export class DeleteDeploymentTool extends AtlasLocalToolBase {
-    public name = "atlas-local-delete-deployment";
-    protected description = "Delete a MongoDB Atlas local deployment";
+    public internalName = "atlas-local-delete-deployment";
+    protected internalDescription = "Delete a MongoDB Atlas local deployment";
     public operationType: OperationType = "delete";
     protected argsShape = {
         deploymentName: CommonArgs.string().describe("Name of the deployment to delete"),
diff --git a/src/tools/atlasLocal/read/listDeployments.ts b/src/tools/atlasLocal/read/listDeployments.ts
@@ -6,8 +6,8 @@ import type { Deployment } from "@mongodb-js/atlas-local";
 import type { Client } from "@mongodb-js/atlas-local";
 
 export class ListDeploymentsTool extends AtlasLocalToolBase {
-    public name = "atlas-local-list-deployments";
-    protected description = "List MongoDB Atlas local deployments";
+    public internalName = "atlas-local-list-deployments";
+    protected internalDescription = "List MongoDB Atlas local deployments";
     public operationType: OperationType = "read";
     protected argsShape = {};
 
diff --git a/src/tools/mongodb/connect/connect.ts b/src/tools/mongodb/connect/connect.ts
@@ -32,8 +32,9 @@ const disconnectedDescription =
     "Connect to a MongoDB instance. The config resource captures if the server is already connected to a MongoDB cluster. If the user has configured a connection string or has previously called the connect tool, a connection is already established and there's no need to call this tool unless the user has explicitly requested to switch to a new MongoDB cluster.";
 
 export class ConnectTool extends MongoDBToolBase {
-    public name: typeof connectedName | typeof disconnectedName = disconnectedName;
-    protected description: typeof connectedDescription | typeof disconnectedDescription = disconnectedDescription;
+    public internalName: typeof connectedName | typeof disconnectedName = disconnectedName;
+    protected internalDescription: typeof connectedDescription | typeof disconnectedDescription =
+        disconnectedDescription;
 
     // Here the default is empty just to trigger registration, but we're going to override it with the correct
     // schema in the register method.
@@ -55,19 +56,18 @@ export class ConnectTool extends MongoDBToolBase {
     }
 
     protected async execute({ connectionString }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
-        switch (this.name) {
-            case disconnectedName:
-                assert(connectionString, "Connection string is required");
-                break;
-            case connectedName:
-                connectionString ??= this.config.connectionString;
-                assert(
-                    connectionString,
-                    "Cannot switch to a new connection because no connection string was provided and no default connection string is configured."
-                );
-                break;
+        const isSwitchConnectionTool = this.name === this.getConfiguredNameFor(connectedName);
+        if (isSwitchConnectionTool) {
+            connectionString ??= this.config.connectionString;
         }
 
+        assert(
+            connectionString,
+            isSwitchConnectionTool
+                ? "Cannot switch to a new connection because no connection string was provided and no default connection string is configured."
+                : "Connection string is required"
+        );
+
         await this.session.connectToMongoDB({ connectionString });
         this.updateMetadata();
 
@@ -107,8 +107,8 @@ export class ConnectTool extends MongoDBToolBase {
         });
 
         this.update?.({
-            name,
-            description,
+            internalName: name,
+            internalDescription: description,
             inputSchema,
         });
     }
diff --git a/src/tools/mongodb/create/createCollection.ts b/src/tools/mongodb/create/createCollection.ts
@@ -3,8 +3,8 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import type { OperationType, ToolArgs } from "../../tool.js";
 
 export class CreateCollectionTool extends MongoDBToolBase {
-    public name = "create-collection";
-    protected description =
+    public internalName = "create-collection";
+    protected internalDescription =
         "Creates a new collection in a database. If the database doesn't exist, it will be created automatically.";
     protected argsShape = DbOperationArgs;
 
diff --git a/src/tools/mongodb/create/createIndex.ts b/src/tools/mongodb/create/createIndex.ts
@@ -64,8 +64,8 @@ export class CreateIndexTool extends MongoDBToolBase {
             ),
     });
 
-    public name = "create-index";
-    protected description = "Create an index for a collection";
+    public internalName = "create-index";
+    protected internalDescription = "Create an index for a collection";
     protected argsShape = {
         ...DbOperationArgs,
         name: z.string().optional().describe("The name of the index"),
diff --git a/src/tools/mongodb/create/insertMany.ts b/src/tools/mongodb/create/insertMany.ts
@@ -16,8 +16,8 @@ const zSupportedEmbeddingParametersWithInput = zSupportedEmbeddingParameters.ext
 });
 
 export class InsertManyTool extends MongoDBToolBase {
-    public name = "insert-many";
-    protected description = "Insert an array of documents into a MongoDB collection";
+    public internalName = "insert-many";
+    protected internalDescription = "Insert an array of documents into a MongoDB collection";
     protected argsShape = {
         ...DbOperationArgs,
         documents: z
diff --git a/src/tools/mongodb/delete/deleteMany.ts b/src/tools/mongodb/delete/deleteMany.ts
@@ -6,8 +6,8 @@ import { EJSON } from "bson";
 import { zEJSON } from "../../args.js";
 
 export class DeleteManyTool extends MongoDBToolBase {
-    public name = "delete-many";
-    protected description = "Removes all documents that match the filter from a MongoDB collection";
+    public internalName = "delete-many";
+    protected internalDescription = "Removes all documents that match the filter from a MongoDB collection";
     protected argsShape = {
         ...DbOperationArgs,
         filter: zEJSON()
diff --git a/src/tools/mongodb/delete/dropCollection.ts b/src/tools/mongodb/delete/dropCollection.ts
@@ -3,8 +3,8 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import type { ToolArgs, OperationType } from "../../tool.js";
 
 export class DropCollectionTool extends MongoDBToolBase {
-    public name = "drop-collection";
-    protected description =
+    public internalName = "drop-collection";
+    protected internalDescription =
         "Removes a collection or view from the database. The method also removes any indexes associated with the dropped collection.";
     protected argsShape = {
         ...DbOperationArgs,
diff --git a/src/tools/mongodb/delete/dropDatabase.ts b/src/tools/mongodb/delete/dropDatabase.ts
@@ -3,8 +3,8 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import type { ToolArgs, OperationType } from "../../tool.js";
 
 export class DropDatabaseTool extends MongoDBToolBase {
-    public name = "drop-database";
-    protected description = "Removes the specified database, deleting the associated data files";
+    public internalName = "drop-database";
+    protected internalDescription = "Removes the specified database, deleting the associated data files";
     protected argsShape = {
         database: DbOperationArgs.database,
     };
diff --git a/src/tools/mongodb/delete/dropIndex.ts b/src/tools/mongodb/delete/dropIndex.ts
@@ -5,8 +5,8 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { type ToolArgs, type OperationType, formatUntrustedData } from "../../tool.js";
 
 export class DropIndexTool extends MongoDBToolBase {
-    public name = "drop-index";
-    protected description = "Drop an index for the provided database and collection.";
+    public internalName = "drop-index";
+    protected internalDescription = "Drop an index for the provided database and collection.";
     protected argsShape = {
         ...DbOperationArgs,
         indexName: z.string().nonempty().describe("The name of the index to be dropped."),
diff --git a/src/tools/mongodb/metadata/collectionIndexes.ts b/src/tools/mongodb/metadata/collectionIndexes.ts
@@ -17,8 +17,8 @@ type IndexStatus = {
 };
 
 export class CollectionIndexesTool extends MongoDBToolBase {
-    public name = "collection-indexes";
-    protected description = "Describe the indexes for a collection";
+    public internalName = "collection-indexes";
+    protected internalDescription = "Describe the indexes for a collection";
     protected argsShape = DbOperationArgs;
     public operationType: OperationType = "metadata";
 
diff --git a/src/tools/mongodb/metadata/collectionSchema.ts b/src/tools/mongodb/metadata/collectionSchema.ts
@@ -11,8 +11,8 @@ import { isObjectEmpty } from "../../../helpers/isObjectEmpty.js";
 const MAXIMUM_SAMPLE_SIZE_HARD_LIMIT = 50_000;
 
 export class CollectionSchemaTool extends MongoDBToolBase {
-    public name = "collection-schema";
-    protected description = "Describe the schema for a collection";
+    public internalName = "collection-schema";
+    protected internalDescription = "Describe the schema for a collection";
     protected argsShape = {
         ...DbOperationArgs,
         sampleSize: z.number().optional().default(50).describe("Number of documents to sample for schema inference"),
diff --git a/src/tools/mongodb/metadata/collectionStorageSize.ts b/src/tools/mongodb/metadata/collectionStorageSize.ts
@@ -3,8 +3,8 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import type { ToolArgs, OperationType } from "../../tool.js";
 
 export class CollectionStorageSizeTool extends MongoDBToolBase {
-    public name = "collection-storage-size";
-    protected description = "Gets the size of the collection";
+    public internalName = "collection-storage-size";
+    protected internalDescription = "Gets the size of the collection";
     protected argsShape = DbOperationArgs;
 
     public operationType: OperationType = "metadata";
diff --git a/src/tools/mongodb/metadata/dbStats.ts b/src/tools/mongodb/metadata/dbStats.ts
@@ -5,8 +5,8 @@ import { formatUntrustedData } from "../../tool.js";
 import { EJSON } from "bson";
 
 export class DbStatsTool extends MongoDBToolBase {
-    public name = "db-stats";
-    protected description = "Returns statistics that reflect the use state of a single database";
+    public internalName = "db-stats";
+    protected internalDescription = "Returns statistics that reflect the use state of a single database";
     protected argsShape = {
         database: DbOperationArgs.database,
     };
diff --git a/src/tools/mongodb/metadata/explain.ts b/src/tools/mongodb/metadata/explain.ts
@@ -9,8 +9,8 @@ import { FindArgs } from "../read/find.js";
 import { CountArgs } from "../read/count.js";
 
 export class ExplainTool extends MongoDBToolBase {
-    public name = "explain";
-    protected description =
+    public internalName = "explain";
+    protected internalDescription =
         "Returns statistics describing the execution of the winning plan chosen by the query optimizer for the evaluated method";
 
     protected argsShape = {
diff --git a/src/tools/mongodb/metadata/listCollections.ts b/src/tools/mongodb/metadata/listCollections.ts
@@ -4,8 +4,8 @@ import type { ToolArgs, OperationType } from "../../tool.js";
 import { formatUntrustedData } from "../../tool.js";
 
 export class ListCollectionsTool extends MongoDBToolBase {
-    public name = "list-collections";
-    protected description = "List all collections for a given database";
+    public internalName = "list-collections";
+    protected internalDescription = "List all collections for a given database";
     protected argsShape = {
         database: DbOperationArgs.database,
     };
diff --git a/src/tools/mongodb/metadata/listDatabases.ts b/src/tools/mongodb/metadata/listDatabases.ts
@@ -5,8 +5,8 @@ import type { OperationType } from "../../tool.js";
 import { formatUntrustedData } from "../../tool.js";
 
 export class ListDatabasesTool extends MongoDBToolBase {
-    public name = "list-databases";
-    protected description = "List all databases for a MongoDB connection";
+    public internalName = "list-databases";
+    protected internalDescription = "List all databases for a MongoDB connection";
     protected argsShape = {};
     public operationType: OperationType = "metadata";
 
diff --git a/src/tools/mongodb/metadata/logs.ts b/src/tools/mongodb/metadata/logs.ts
diff --git a/src/tools/mongodb/read/aggregate.ts b/src/tools/mongodb/read/aggregate.ts
diff --git a/src/tools/mongodb/read/count.ts b/src/tools/mongodb/read/count.ts
diff --git a/src/tools/mongodb/read/export.ts b/src/tools/mongodb/read/export.ts
diff --git a/src/tools/mongodb/read/find.ts b/src/tools/mongodb/read/find.ts
diff --git a/src/tools/mongodb/update/renameCollection.ts b/src/tools/mongodb/update/renameCollection.ts
diff --git a/src/tools/mongodb/update/updateMany.ts b/src/tools/mongodb/update/updateMany.ts
diff --git a/src/tools/tool.ts b/src/tools/tool.ts
diff --git a/tests/integration/customTools.test.ts b/tests/integration/customTools.test.ts
diff --git a/tests/integration/tools/mongodb/connect/connect.test.ts b/tests/integration/tools/mongodb/connect/connect.test.ts
diff --git a/tests/integration/tools/mongodb/mongodbTool.test.ts b/tests/integration/tools/mongodb/mongodbTool.test.ts
diff --git a/tests/unit/toolBase.test.ts b/tests/unit/toolBase.test.ts
