wip

Author: blva

src/tools/args.ts

@@ -29,7 +29,7 @@ export const CommonArgs = {
 };
 
 export const AtlasArgs = {
-    projectId: (): z.ZodString => CommonArgs.objectId("projectId"),
+    projectId: (): z.ZodString => CommonArgs.objectId("projectId").describe("Atlas project ID"),
 
     organizationId: (): z.ZodString => CommonArgs.objectId("organizationId"),
 
@@ -68,3 +68,12 @@ export const AtlasArgs = {
     password: (): z.ZodString =>
         z.string().min(1, "Password is required").max(100, "Password must be 100 characters or less"),
 };
+
+export const ProjectAndClusterArgs = {
+    projectId: AtlasArgs.projectId(),
+    clusterName: AtlasArgs.clusterName().describe("Atlas cluster name"),
+};
+
+export const ProjectArgs = {
+    projectId: AtlasArgs.projectId(),
+};

src/tools/atlas/connect/connectCluster.ts

@@ -20,7 +20,7 @@ function sleep(ms: number): Promise<void> {
 }
 
 export const ConnectClusterArgs = {
-    projectId: AtlasArgs.projectId().describe("Atlas project ID"),
+    projectId: AtlasArgs.projectId(),
     clusterName: AtlasArgs.clusterName().describe("Atlas cluster name"),
 };
 

src/tools/atlas/create/createAccessList.ts

@@ -3,10 +3,10 @@ import { type OperationType, type ToolArgs } from "../../tool.js";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { AtlasToolBase } from "../atlasTool.js";
 import { makeCurrentIpAccessListEntry, DEFAULT_ACCESS_LIST_COMMENT } from "../../../common/atlas/accessListUtils.js";
-import { AtlasArgs, CommonArgs } from "../../args.js";
+import { AtlasArgs, CommonArgs, ProjectArgs } from "../../args.js";
 
 export const CreateAccessListArgs = {
-    projectId: AtlasArgs.projectId().describe("Atlas project ID"),
+    ...ProjectArgs,
     ipAddresses: z.array(AtlasArgs.ipAddress()).describe("IP addresses to allow access from").optional(),
     cidrBlocks: z.array(AtlasArgs.cidrBlock()).describe("CIDR blocks to allow access from").optional(),
     currentIpAddress: z.boolean().describe("Add the current IP address").default(false),

src/tools/atlas/create/createDBUser.ts

@@ -8,7 +8,7 @@ import { ensureCurrentIpInAccessList } from "../../../common/atlas/accessListUti
 import { AtlasArgs, CommonArgs } from "../../args.js";
 
 export const CreateDBUserArgs = {
-    projectId: AtlasArgs.projectId().describe("Atlas project ID"),
+    projectId: AtlasArgs.projectId(),
     username: AtlasArgs.username().describe("Username for the new user"),
     // Models will generate overly simplistic passwords like SecurePassword123 or
     // AtlasPassword123, which are easily guessable and exploitable. We're instructing
@@ -26,7 +26,7 @@ export const CreateDBUserArgs = {
                 collectionName: CommonArgs.string().describe("Collection name").optional(),
             })
         )
-        .describe("Roles for the new user"),
+        .describe("Roles for the new database user"),
     clusters: z
         .array(AtlasArgs.clusterName())
         .describe("Clusters to assign the user to, leave empty for access to all clusters")
@@ -35,7 +35,7 @@ export const CreateDBUserArgs = {
 
 export class CreateDBUserTool extends AtlasToolBase {
     public name = "atlas-create-db-user";
-    protected description = "Create an MongoDB Atlas database user";
+    protected description = "Create a MongoDB Atlas database user";
     public operationType: OperationType = "create";
     protected argsShape = {
         ...CreateDBUserArgs,

src/tools/atlas/read/inspectAccessList.ts

@@ -4,7 +4,7 @@ import { AtlasToolBase } from "../atlasTool.js";
 import { AtlasArgs } from "../../args.js";
 
 export const InspectAccessListArgs = {
-    projectId: AtlasArgs.projectId().describe("Atlas project ID"),
+    projectId: AtlasArgs.projectId(),
 };
 
 export class InspectAccessListTool extends AtlasToolBase {

src/tools/atlas/read/inspectCluster.ts

@@ -3,19 +3,14 @@ import { type OperationType, type ToolArgs, formatUntrustedData } from "../../to
 import { AtlasToolBase } from "../atlasTool.js";
 import type { Cluster } from "../../../common/atlas/cluster.js";
 import { inspectCluster } from "../../../common/atlas/cluster.js";
-import { AtlasArgs } from "../../args.js";
-
-export const InspectClusterArgs = {
-    projectId: AtlasArgs.projectId().describe("Atlas project ID"),
-    clusterName: AtlasArgs.clusterName().describe("Atlas cluster name"),
-};
+import { ProjectAndClusterArgs } from "../../args.js";
 
 export class InspectClusterTool extends AtlasToolBase {
     public name = "atlas-inspect-cluster";
     protected description = "Inspect MongoDB Atlas cluster";
     public operationType: OperationType = "read";
     protected argsShape = {
-        ...InspectClusterArgs,
+        ...ProjectAndClusterArgs,
     };
 
     protected async execute({ projectId, clusterName }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {

tests/integration/helpers.ts

@@ -247,19 +247,6 @@ export const createClusterParameters: ParameterInfo[] = [
     { name: "region", type: "string", description: "Region of the cluster", required: false },
 ];
 
-export const createDbUserParameters: ParameterInfo[] = [
-    {
-        name: "projectId",
-        type: "string",
-        description: "Atlas project ID to create the database user in",
-        required: true,
-    },
-    { name: "username", type: "string", description: "Username of the database user", required: true },
-    { name: "password", type: "string", description: "Password of the database user", required: false },
-    { name: "roles", type: "array", description: "Roles of the database user", required: true },
-    { name: "scopes", type: "array", description: "Scopes of the database user", required: false },
-];
-
 export const databaseCollectionInvalidArgs = [
     {},
     { database: "test" },

tests/integration/tools/atlas/dbUsers.test.ts

@@ -4,16 +4,13 @@ import {
     getResponseElements,
     projectIdInvalidArgs,
     validateThrowsForInvalidArguments,
-    validateToolMetadata,
-    createDbUserParameters,
 } from "../../helpers.js";
 import { ApiClientError } from "../../../../src/common/atlas/apiClientError.js";
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
 import { Keychain } from "../../../../src/common/keychain.js";
 
 describeWithAtlas("db users", (integration) => {
     describe("should have correct metadata and validate invalid arguments", () => {
-        validateToolMetadata(integration, "atlas-create-db-user", "Create a database user", createDbUserParameters);
         validateThrowsForInvalidArguments(integration, "atlas-create-db-user", projectIdInvalidArgs);
     });