mongodb-mcp-server 0.1.2 → 0.2.0

package/src/tools/atlas/create/createAccessList.ts

@@ -2,13 +2,12 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
-
-const DEFAULT_COMMENT = "Added by Atlas MCP";
+import { makeCurrentIpAccessListEntry, DEFAULT_ACCESS_LIST_COMMENT } from "../../../common/atlas/accessListUtils.js";
 
 export class CreateAccessListTool extends AtlasToolBase {
-    protected name = "atlas-create-access-list";
+    public name = "atlas-create-access-list";
     protected description = "Allow Ip/CIDR ranges to access your MongoDB Atlas clusters.";
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID"),
         ipAddresses: z
@@ -17,7 +16,11 @@ export class CreateAccessListTool extends AtlasToolBase {
             .optional(),
         cidrBlocks: z.array(z.string().cidr()).describe("CIDR blocks to allow access from").optional(),
         currentIpAddress: z.boolean().describe("Add the current IP address").default(false),
-        comment: z.string().describe("Comment for the access list entries").default(DEFAULT_COMMENT).optional(),
+        comment: z
+            .string()
+            .describe("Comment for the access list entries")
+            .default(DEFAULT_ACCESS_LIST_COMMENT)
+            .optional(),
     };
 
     protected async execute({
@@ -34,23 +37,22 @@ export class CreateAccessListTool extends AtlasToolBase {
         const ipInputs = (ipAddresses || []).map((ipAddress) => ({
             groupId: projectId,
             ipAddress,
-            comment: comment || DEFAULT_COMMENT,
+            comment: comment || DEFAULT_ACCESS_LIST_COMMENT,
         }));
 
         if (currentIpAddress) {
-            const currentIp = await this.session.apiClient.getIpInfo();
-            const input = {
-                groupId: projectId,
-                ipAddress: currentIp.currentIpv4Address,
-                comment: comment || DEFAULT_COMMENT,
-            };
+            const input = await makeCurrentIpAccessListEntry(
+                this.session.apiClient,
+                projectId,
+                comment || DEFAULT_ACCESS_LIST_COMMENT
+            );
             ipInputs.push(input);
         }
 
         const cidrInputs = (cidrBlocks || []).map((cidrBlock) => ({
             groupId: projectId,
             cidrBlock,
-            comment: comment || DEFAULT_COMMENT,
+            comment: comment || DEFAULT_ACCESS_LIST_COMMENT,
         }));
 
         const inputs = [...ipInputs, ...cidrInputs];

package/src/tools/atlas/create/createDBUser.ts

@@ -3,12 +3,13 @@ import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 import { CloudDatabaseUser, DatabaseUserRole } from "../../../common/atlas/openapi.js";
-import { generateSecurePassword } from "../../../common/atlas/generatePassword.js";
+import { generateSecurePassword } from "../../../helpers/generatePassword.js";
+import { ensureCurrentIpInAccessList } from "../../../common/atlas/accessListUtils.js";
 
 export class CreateDBUserTool extends AtlasToolBase {
-    protected name = "atlas-create-db-user";
+    public name = "atlas-create-db-user";
     protected description = "Create an MongoDB Atlas database user";
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID"),
         username: z.string().describe("Username for the new user"),
@@ -44,6 +45,7 @@ export class CreateDBUserTool extends AtlasToolBase {
         roles,
         clusters,
     }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
+        await ensureCurrentIpInAccessList(this.session.apiClient, projectId);
         const shouldGeneratePassword = !password;
         if (shouldGeneratePassword) {
             password = await generateSecurePassword();

package/src/tools/atlas/create/createFreeCluster.ts

@@ -3,11 +3,12 @@ import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 import { ClusterDescription20240805 } from "../../../common/atlas/openapi.js";
+import { ensureCurrentIpInAccessList } from "../../../common/atlas/accessListUtils.js";
 
 export class CreateFreeClusterTool extends AtlasToolBase {
-    protected name = "atlas-create-free-cluster";
+    public name = "atlas-create-free-cluster";
     protected description = "Create a free MongoDB Atlas cluster";
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID to create the cluster in"),
         name: z.string().describe("Name of the cluster"),
@@ -37,6 +38,7 @@ export class CreateFreeClusterTool extends AtlasToolBase {
             terminationProtectionEnabled: false,
         } as unknown as ClusterDescription20240805;
 
+        await ensureCurrentIpInAccessList(this.session.apiClient, projectId);
         await this.session.apiClient.createCluster({
             params: {
                 path: {

package/src/tools/atlas/create/createProject.ts

@@ -5,9 +5,9 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { Group } from "../../../common/atlas/openapi.js";
 
 export class CreateProjectTool extends AtlasToolBase {
-    protected name = "atlas-create-project";
+    public name = "atlas-create-project";
     protected description = "Create a MongoDB Atlas project";
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
     protected argsShape = {
         projectName: z.string().optional().describe("Name for the new project"),
         organizationId: z.string().optional().describe("Organization ID for the new project"),

package/src/tools/atlas/read/inspectAccessList.ts

@@ -4,9 +4,9 @@ import { AtlasToolBase } from "../atlasTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class InspectAccessListTool extends AtlasToolBase {
-    protected name = "atlas-inspect-access-list";
+    public name = "atlas-inspect-access-list";
     protected description = "Inspect Ip/CIDR ranges with access to your MongoDB Atlas clusters.";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID"),
     };

package/src/tools/atlas/read/inspectCluster.ts

@@ -5,9 +5,9 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { Cluster, inspectCluster } from "../../../common/atlas/cluster.js";
 
 export class InspectClusterTool extends AtlasToolBase {
-    protected name = "atlas-inspect-cluster";
+    public name = "atlas-inspect-cluster";
     protected description = "Inspect MongoDB Atlas cluster";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID"),
         clusterName: z.string().describe("Atlas cluster name"),

package/src/tools/atlas/read/listAlerts.ts

@@ -4,9 +4,9 @@ import { AtlasToolBase } from "../atlasTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class ListAlertsTool extends AtlasToolBase {
-    protected name = "atlas-list-alerts";
+    public name = "atlas-list-alerts";
     protected description = "List MongoDB Atlas alerts";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID to list alerts for"),
     };

package/src/tools/atlas/read/listClusters.ts

@@ -11,9 +11,9 @@ import {
 import { formatCluster, formatFlexCluster } from "../../../common/atlas/cluster.js";
 
 export class ListClustersTool extends AtlasToolBase {
-    protected name = "atlas-list-clusters";
+    public name = "atlas-list-clusters";
     protected description = "List MongoDB Atlas clusters";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID to filter clusters").optional(),
     };

package/src/tools/atlas/read/listDBUsers.ts

@@ -5,9 +5,9 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { DatabaseUserRole, UserScope } from "../../../common/atlas/openapi.js";
 
 export class ListDBUsersTool extends AtlasToolBase {
-    protected name = "atlas-list-db-users";
+    public name = "atlas-list-db-users";
     protected description = "List MongoDB Atlas database users";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {
         projectId: z.string().describe("Atlas project ID to filter DB users"),
     };

package/src/tools/atlas/read/listOrgs.ts

@@ -3,9 +3,9 @@ import { AtlasToolBase } from "../atlasTool.js";
 import { OperationType } from "../../tool.js";
 
 export class ListOrganizationsTool extends AtlasToolBase {
-    protected name = "atlas-list-orgs";
+    public name = "atlas-list-orgs";
     protected description = "List MongoDB Atlas organizations";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {};
 
     protected async execute(): Promise<CallToolResult> {

package/src/tools/atlas/read/listProjects.ts

@@ -5,9 +5,9 @@ import { z } from "zod";
 import { ToolArgs } from "../../tool.js";
 
 export class ListProjectsTool extends AtlasToolBase {
-    protected name = "atlas-list-projects";
+    public name = "atlas-list-projects";
     protected description = "List MongoDB Atlas projects";
-    protected operationType: OperationType = "read";
+    public operationType: OperationType = "read";
     protected argsShape = {
         orgId: z.string().describe("Atlas organization ID to filter projects").optional(),
     };

package/src/tools/atlas/tools.ts

@@ -8,7 +8,7 @@ import { ListDBUsersTool } from "./read/listDBUsers.js";
 import { CreateDBUserTool } from "./create/createDBUser.js";
 import { CreateProjectTool } from "./create/createProject.js";
 import { ListOrganizationsTool } from "./read/listOrgs.js";
-import { ConnectClusterTool } from "./metadata/connectCluster.js";
+import { ConnectClusterTool } from "./connect/connectCluster.js";
 import { ListAlertsTool } from "./read/listAlerts.js";
 
 export const AtlasTools = [

package/src/tools/mongodb/{metadata → connect}/connect.ts

@@ -2,11 +2,11 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import assert from "assert";
-import { UserConfig } from "../../../config.js";
+import { UserConfig } from "../../../common/config.js";
 import { Telemetry } from "../../../telemetry/telemetry.js";
-import { Session } from "../../../session.js";
+import { Session } from "../../../common/session.js";
+import { Server } from "../../../server.js";
 
 const disconnectedSchema = z
     .object({
@@ -33,7 +33,7 @@ const connectedDescription =
 const disconnectedDescription = "Connect to a MongoDB instance";
 
 export class ConnectTool extends MongoDBToolBase {
-    protected name: typeof connectedName | typeof disconnectedName = disconnectedName;
+    public name: typeof connectedName | typeof disconnectedName = disconnectedName;
     protected description: typeof connectedDescription | typeof disconnectedDescription = disconnectedDescription;
 
     // Here the default is empty just to trigger registration, but we're going to override it with the correct
@@ -42,11 +42,11 @@ export class ConnectTool extends MongoDBToolBase {
         connectionString: z.string().optional(),
     };
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "connect";
 
     constructor(session: Session, config: UserConfig, telemetry: Telemetry) {
         super(session, config, telemetry);
-        session.on("close", () => {
+        session.on("disconnect", () => {
             this.updateMetadata();
         });
     }
@@ -72,10 +72,13 @@ export class ConnectTool extends MongoDBToolBase {
         };
     }
 
-    public register(server: McpServer): void {
-        super.register(server);
+    public register(server: Server): boolean {
+        if (super.register(server)) {
+            this.updateMetadata();
+            return true;
+        }
 
-        this.updateMetadata();
+        return false;
     }
 
     private updateMetadata(): void {

package/src/tools/mongodb/create/createCollection.ts

@@ -3,12 +3,12 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { OperationType, ToolArgs } from "../../tool.js";
 
 export class CreateCollectionTool extends MongoDBToolBase {
-    protected name = "create-collection";
+    public name = "create-collection";
     protected description =
         "Creates a new collection in a database. If the database doesn't exist, it will be created automatically.";
     protected argsShape = DbOperationArgs;
 
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
 
     protected async execute({ collection, database }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/create/createIndex.ts

@@ -5,15 +5,15 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { IndexDirection } from "mongodb";
 
 export class CreateIndexTool extends MongoDBToolBase {
-    protected name = "create-index";
+    public name = "create-index";
     protected description = "Create an index for a collection";
     protected argsShape = {
         ...DbOperationArgs,
-        keys: z.record(z.string(), z.custom<IndexDirection>()).describe("The index definition"),
+        keys: z.object({}).catchall(z.custom<IndexDirection>()).describe("The index definition"),
         name: z.string().optional().describe("The name of the index"),
     };
 
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
 
     protected async execute({
         database,

package/src/tools/mongodb/create/insertMany.ts

@@ -4,17 +4,17 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class InsertManyTool extends MongoDBToolBase {
-    protected name = "insert-many";
+    public name = "insert-many";
     protected description = "Insert an array of documents into a MongoDB collection";
     protected argsShape = {
         ...DbOperationArgs,
         documents: z
-            .array(z.record(z.string(), z.unknown()).describe("An individual MongoDB document"))
+            .array(z.object({}).passthrough().describe("An individual MongoDB document"))
             .describe(
                 "The array of documents to insert, matching the syntax of the document argument of db.collection.insertMany()"
             ),
     };
-    protected operationType: OperationType = "create";
+    public operationType: OperationType = "create";
 
     protected async execute({
         database,

package/src/tools/mongodb/delete/deleteMany.ts

@@ -2,20 +2,22 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
+import { checkIndexUsage } from "../../../helpers/indexCheck.js";
 
 export class DeleteManyTool extends MongoDBToolBase {
-    protected name = "delete-many";
+    public name = "delete-many";
     protected description = "Removes all documents that match the filter from a MongoDB collection";
     protected argsShape = {
         ...DbOperationArgs,
         filter: z
-            .record(z.string(), z.unknown())
+            .object({})
+            .passthrough()
             .optional()
             .describe(
                 "The query filter, specifying the deletion criteria. Matches the syntax of the filter argument of db.collection.deleteMany()"
             ),
     };
-    protected operationType: OperationType = "delete";
+    public operationType: OperationType = "delete";
 
     protected async execute({
         database,
@@ -23,6 +25,25 @@ export class DeleteManyTool extends MongoDBToolBase {
         filter,
     }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();
+
+        // Check if delete operation uses an index if enabled
+        if (this.config.indexCheck) {
+            await checkIndexUsage(provider, database, collection, "deleteMany", async () => {
+                return provider.runCommandWithCheck(database, {
+                    explain: {
+                        delete: collection,
+                        deletes: [
+                            {
+                                q: filter || {},
+                                limit: 0, // 0 means delete all matching documents
+                            },
+                        ],
+                    },
+                    verbosity: "queryPlanner",
+                });
+            });
+        }
+
         const result = await provider.deleteMany(database, collection, filter);
 
         return {

package/src/tools/mongodb/delete/dropCollection.ts

@@ -3,13 +3,13 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class DropCollectionTool extends MongoDBToolBase {
-    protected name = "drop-collection";
+    public name = "drop-collection";
     protected description =
         "Removes a collection or view from the database. The method also removes any indexes associated with the dropped collection.";
     protected argsShape = {
         ...DbOperationArgs,
     };
-    protected operationType: OperationType = "delete";
+    public operationType: OperationType = "delete";
 
     protected async execute({ database, collection }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/delete/dropDatabase.ts

@@ -3,12 +3,12 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class DropDatabaseTool extends MongoDBToolBase {
-    protected name = "drop-database";
+    public name = "drop-database";
     protected description = "Removes the specified database, deleting the associated data files";
     protected argsShape = {
         database: DbOperationArgs.database,
     };
-    protected operationType: OperationType = "delete";
+    public operationType: OperationType = "delete";
 
     protected async execute({ database }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/metadata/collectionSchema.ts

@@ -4,11 +4,11 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { getSimplifiedSchema } from "mongodb-schema";
 
 export class CollectionSchemaTool extends MongoDBToolBase {
-    protected name = "collection-schema";
+    public name = "collection-schema";
     protected description = "Describe the schema for a collection";
     protected argsShape = DbOperationArgs;
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     protected async execute({ database, collection }: ToolArgs<typeof DbOperationArgs>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/metadata/collectionStorageSize.ts

@@ -3,11 +3,11 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class CollectionStorageSizeTool extends MongoDBToolBase {
-    protected name = "collection-storage-size";
+    public name = "collection-storage-size";
     protected description = "Gets the size of the collection";
     protected argsShape = DbOperationArgs;
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     protected async execute({ database, collection }: ToolArgs<typeof DbOperationArgs>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/metadata/dbStats.ts

@@ -4,13 +4,13 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { EJSON } from "bson";
 
 export class DbStatsTool extends MongoDBToolBase {
-    protected name = "db-stats";
+    public name = "db-stats";
     protected description = "Returns statistics that reflect the use state of a single database";
     protected argsShape = {
         database: DbOperationArgs.database,
     };
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     protected async execute({ database }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/metadata/explain.ts

@@ -8,7 +8,7 @@ import { FindArgs } from "../read/find.js";
 import { CountArgs } from "../read/count.js";
 
 export class ExplainTool extends MongoDBToolBase {
-    protected name = "explain";
+    public name = "explain";
     protected description =
         "Returns statistics describing the execution of the winning plan chosen by the query optimizer for the evaluated method";
 
@@ -16,7 +16,7 @@ export class ExplainTool extends MongoDBToolBase {
         ...DbOperationArgs,
         method: z
             .array(
-                z.union([
+                z.discriminatedUnion("name", [
                     z.object({
                         name: z.literal("aggregate"),
                         arguments: z.object(AggregateArgs),
@@ -34,7 +34,7 @@ export class ExplainTool extends MongoDBToolBase {
             .describe("The method and its arguments to run"),
     };
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     static readonly defaultVerbosity = ExplainVerbosity.queryPlanner;
 
@@ -76,7 +76,7 @@ export class ExplainTool extends MongoDBToolBase {
             }
             case "count": {
                 const { query } = method.arguments;
-                result = await provider.mongoClient.db(database).command({
+                result = await provider.runCommandWithCheck(database, {
                     explain: {
                         count: collection,
                         query,

package/src/tools/mongodb/metadata/listCollections.ts

@@ -3,13 +3,13 @@ import { DbOperationArgs, MongoDBToolBase } from "../mongodbTool.js";
 import { ToolArgs, OperationType } from "../../tool.js";
 
 export class ListCollectionsTool extends MongoDBToolBase {
-    protected name = "list-collections";
+    public name = "list-collections";
     protected description = "List all collections for a given database";
     protected argsShape = {
         database: DbOperationArgs.database,
     };
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     protected async execute({ database }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/metadata/listDatabases.ts

@@ -4,10 +4,10 @@ import * as bson from "bson";
 import { OperationType } from "../../tool.js";
 
 export class ListDatabasesTool extends MongoDBToolBase {
-    protected name = "list-databases";
+    public name = "list-databases";
     protected description = "List all databases for a MongoDB connection";
     protected argsShape = {};
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     protected async execute(): Promise<CallToolResult> {
         const provider = await this.ensureConnected();

package/src/tools/mongodb/metadata/logs.ts

@@ -4,7 +4,7 @@ import { ToolArgs, OperationType } from "../../tool.js";
 import { z } from "zod";
 
 export class LogsTool extends MongoDBToolBase {
-    protected name = "mongodb-logs";
+    public name = "mongodb-logs";
     protected description = "Returns the most recent logged mongod events";
     protected argsShape = {
         type: z
@@ -24,7 +24,7 @@ export class LogsTool extends MongoDBToolBase {
             .describe("The maximum number of log entries to return."),
     };
 
-    protected operationType: OperationType = "metadata";
+    public operationType: OperationType = "metadata";
 
     protected async execute({ type, limit }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         const provider = await this.ensureConnected();