feat: add atlas-list-orgs

Author: fmenezes

scripts/filter.ts

@@ -22,6 +22,7 @@ function filterOpenapi(openapi: OpenAPIV3_1.Document): OpenAPIV3_1.Document {
         "listOrganizations",
         "getProject",
         "createProject",
+        "deleteProject",
         "listClusters",
         "getCluster",
         "createCluster",
@@ -33,6 +34,7 @@ function filterOpenapi(openapi: OpenAPIV3_1.Document): OpenAPIV3_1.Document {
         "listProjectIpAccessLists",
         "createProjectIpAccessList",
         "deleteProjectIpAccessList",
+        "listOrganizationProjects",
     ];
 
     const filteredPaths = {};

src/common/atlas/apiClient.ts

@@ -132,6 +132,10 @@ export class ApiClient {
         return data;
     }
 
+    async deleteProject(options: FetchOptions<operations["deleteProject"]>) {
+        await this.client.DELETE("/api/atlas/v2/groups/{groupId}", options);
+    }
+
     async getProject(options: FetchOptions<operations["getProject"]>) {
         const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}", options);
         return data;
@@ -189,5 +193,10 @@ export class ApiClient {
         return data;
     }
 
+    async listOrganizationProjects(options: FetchOptions<operations["listOrganizationProjects"]>) {
+        const { data } = await this.client.GET("/api/atlas/v2/orgs/{orgId}/groups", options);
+        return data;
+    }
+
     // DO NOT EDIT. This is auto-generated code.
 }

src/common/atlas/openapi.d.ts

@@ -62,7 +62,11 @@ export interface paths {
         get: operations["getProject"];
         put?: never;
         post?: never;
-        delete?: never;
+        /**
+         * Remove One Project
+         * @description Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
+         */
+        delete: operations["deleteProject"];
         options?: never;
         head?: never;
         patch?: never;
@@ -232,6 +236,33 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/atlas/v2/orgs/{orgId}/groups": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Return One or More Projects in One Organization
+         * @description Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:
+         *
+         *     - Isolate different environments, such as development, test, or production environments, from each other.
+         *     - Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.
+         *     - Maintain separate cluster security configurations.
+         *     - Create different alert settings.
+         *
+         *     To use this resource, the requesting Service Account or API Key must have the Organization Member role.
+         */
+        get: operations["listOrganizationProjects"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -4901,6 +4932,8 @@ export interface components {
         includeCount: boolean;
         /** @description Number of items that the response returns per page. */
         itemsPerPage: number;
+        /** @description Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. */
+        orgId: string;
         /** @description Number of the page that displays the current set of the total objects that the response returns. */
         pageNum: number;
         /** @description Flag that indicates whether the response body should be in the prettyprint format. */
@@ -5147,6 +5180,7 @@ export type ParameterEnvelope = components['parameters']['envelope'];
 export type ParameterGroupId = components['parameters']['groupId'];
 export type ParameterIncludeCount = components['parameters']['includeCount'];
 export type ParameterItemsPerPage = components['parameters']['itemsPerPage'];
+export type ParameterOrgId = components['parameters']['orgId'];
 export type ParameterPageNum = components['parameters']['pageNum'];
 export type ParameterPretty = components['parameters']['pretty'];
 export type $defs = Record<string, never>;
@@ -5289,6 +5323,40 @@ export interface operations {
             500: components["responses"]["internalServerError"];
         };
     };
+    deleteProject: {
+        parameters: {
+            query?: {
+                /** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
+                envelope?: components["parameters"]["envelope"];
+                /** @description Flag that indicates whether the response body should be in the prettyprint format. */
+                pretty?: components["parameters"]["pretty"];
+            };
+            header?: never;
+            path: {
+                /** @description Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
+                 *
+                 *     **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. */
+                groupId: components["parameters"]["groupId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description This endpoint does not return a response body. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.atlas.2023-01-01+json": unknown;
+                };
+            };
+            400: components["responses"]["badRequest"];
+            404: components["responses"]["notFound"];
+            409: components["responses"]["conflict"];
+            500: components["responses"]["internalServerError"];
+        };
+    };
     listProjectIpAccessLists: {
         parameters: {
             query?: {
@@ -5735,6 +5803,46 @@ export interface operations {
             500: components["responses"]["internalServerError"];
         };
     };
+    listOrganizationProjects: {
+        parameters: {
+            query?: {
+                /** @description Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. */
+                envelope?: components["parameters"]["envelope"];
+                /** @description Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. */
+                includeCount?: components["parameters"]["includeCount"];
+                /** @description Number of items that the response returns per page. */
+                itemsPerPage?: components["parameters"]["itemsPerPage"];
+                /** @description Number of the page that displays the current set of the total objects that the response returns. */
+                pageNum?: components["parameters"]["pageNum"];
+                /** @description Flag that indicates whether the response body should be in the prettyprint format. */
+                pretty?: components["parameters"]["pretty"];
+                /** @description Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name. */
+                name?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. */
+                orgId: components["parameters"]["orgId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/vnd.atlas.2023-01-01+json": components["schemas"]["PaginatedAtlasGroupView"];
+                };
+            };
+            400: components["responses"]["badRequest"];
+            401: components["responses"]["unauthorized"];
+            404: components["responses"]["notFound"];
+            500: components["responses"]["internalServerError"];
+        };
+    };
 }
 type WithRequired<T, K extends keyof T> = T & {
     [P in K]-?: T[P];

src/tools/atlas/listOrgs.ts

@@ -0,0 +1,34 @@
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { AtlasToolBase } from "./atlasTool.js";
+import { OperationType } from "../tool.js";
+
+export class ListOrganizationsTool extends AtlasToolBase {
+    protected name = "atlas-list-orgs";
+    protected description = "List MongoDB Atlas organizations";
+    protected operationType: OperationType = "read";
+    protected argsShape = {};
+
+    protected async execute(): Promise<CallToolResult> {
+        this.session.ensureAuthenticated();
+
+        const data = await this.session.apiClient.listOrganizations();
+
+        if (!data?.results?.length) {
+            throw new Error("No projects found in your MongoDB Atlas account.");
+        }
+
+        // Format projects as a table
+        const output =
+            `Organization Name | Organization ID
+----------------| ----------------
+` +
+            data.results
+                .map((org) => {
+                    return `${org.name} | ${org.id}`;
+                })
+                .join("\n");
+        return {
+            content: [{ type: "text", text: output }],
+        };
+    }
+}

src/tools/atlas/listProjects.ts

@@ -1,17 +1,27 @@
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { AtlasToolBase } from "./atlasTool.js";
 import { OperationType } from "../tool.js";
+import { z } from "zod";
+import { ToolArgs } from "../tool.js";
 
 export class ListProjectsTool extends AtlasToolBase {
     protected name = "atlas-list-projects";
     protected description = "List MongoDB Atlas projects";
     protected operationType: OperationType = "read";
-    protected argsShape = {};
+    protected argsShape = {
+        orgId: z.string().describe("Atlas organization ID to filter projects").optional(),
+    };
 
-    protected async execute(): Promise<CallToolResult> {
+    protected async execute({ orgId }: ToolArgs<typeof this.argsShape>): Promise<CallToolResult> {
         this.session.ensureAuthenticated();
 
-        const data = await this.session.apiClient.listProjects();
+        const data = orgId
+            ? await this.session.apiClient.listOrganizationProjects({
+                  params: {
+                      orgId,
+                  },
+              })
+            : await this.session.apiClient.listProjects();
 
         if (!data?.results?.length) {
             throw new Error("No projects found in your MongoDB Atlas account.");

src/tools/atlas/tools.ts

@@ -7,6 +7,7 @@ import { InspectAccessListTool } from "./inspectAccessList.js";
 import { ListDBUsersTool } from "./listDBUsers.js";
 import { CreateDBUserTool } from "./createDBUser.js";
 import { CreateProjectTool } from "./createProject.js";
+import { ListOrganizationsTool } from "./listOrgs.js";
 
 export const AtlasTools = [
     ListClustersTool,
@@ -18,4 +19,5 @@ export const AtlasTools = [
     ListDBUsersTool,
     CreateDBUserTool,
     CreateProjectTool,
+    ListOrganizationsTool
 ];