14993354207

Committed 13 May 2025 09:39AM UTC coverage: 74.808%. First build

Build # 14993354207

Build Type

Pull #230

github

Committed by

web-flow

Commit Message

Merge d2948f551 into d54c92107

Pull Request Pull Request #230: feat: Alerts Listing

Run Details

205 of 357 branches covered (57.42%)

Branch coverage included in aggregate %.

10 of 17 new or added lines in 2 files covered. (58.82%)

769 of 945 relevant lines covered (81.38%)

49.79 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

67.86

/src/tools/mongodb/mongodbTool.ts

import { z } from "zod";
import { ToolArgs, ToolBase, ToolCategory, TelemetryToolMetadata } from "../tool.js";
import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { ErrorCodes, MongoDBError } from "../../errors.js";
import logger, { LogId } from "../../logger.js";

export const DbOperationArgs = {
    database: z.string().describe("Database name"),
    collection: z.string().describe("Collection name"),
};

export abstract class MongoDBToolBase extends ToolBase {
    protected category: ToolCategory = "mongodb";

    protected async ensureConnected(): Promise<NodeDriverServiceProvider> {
        if (!this.session.serviceProvider && this.config.connectionString) {
            try {
                await this.connectToMongoDB(this.config.connectionString);
            } catch (error) {
                logger.error(
                    LogId.mongodbConnectFailure,
                    "mongodbTool",
                    `Failed to connect to MongoDB instance using the connection string from the config: ${error as string}`
                );
                throw new MongoDBError(ErrorCodes.MisconfiguredConnectionString, "Not connected to MongoDB.");
            }
        }

        if (!this.session.serviceProvider) {
            throw new MongoDBError(ErrorCodes.NotConnectedToMongoDB, "Not connected to MongoDB");
        }

        return this.session.serviceProvider;
    }

    protected handleError(
        error: unknown,
        args: ToolArgs<typeof this.argsShape>
    ): Promise<CallToolResult> | CallToolResult {
        if (error instanceof MongoDBError) {
            switch (error.code) {
                case ErrorCodes.NotConnectedToMongoDB:
                    return {
                        content: [
                            {
                                type: "text",
                                text: "You need to connect to a MongoDB instance before you can access its data.",
                            },
                            {
                                type: "text",
                                text: "Please use the 'connect' or 'switch-connection' tool to connect to a MongoDB instance.",
                            },
                        ],
                        isError: true,
                    };
                case ErrorCodes.MisconfiguredConnectionString:
                    return {
                        content: [
                            {
                                type: "text",
                                text: "The configured connection string is not valid. Please check the connection string and confirm it points to a valid MongoDB instance. Alternatively, use the 'switch-connection' tool to connect to a different instance.",
                            },
                        ],
                        isError: true,
                    };
            }
        }

        return super.handleError(error, args);
    }

    protected connectToMongoDB(connectionString: string): Promise<void> {
        return this.session.connectToMongoDB(connectionString, this.config.connectOptions);
    }

    protected resolveTelemetryMetadata(
        // eslint-disable-next-line @typescript-eslint/no-unused-vars
        args: ToolArgs<typeof this.argsShape>
    ): TelemetryToolMetadata {
        const metadata: TelemetryToolMetadata = {};

        // Add projectId to the metadata if running a MongoDB operation to an Atlas cluster
        if (this.session.connectedAtlasCluster?.projectId) {
            metadata.projectId = this.session.connectedAtlasCluster.projectId;
        }

        return metadata;
    }
}

1	import { z } from "zod";
2	import { ToolArgs, ToolBase, ToolCategory, TelemetryToolMetadata } from "../tool.js";
3	import { NodeDriverServiceProvider } from "@mongosh/service-provider-node-driver";
4	import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
5	import { ErrorCodes, MongoDBError } from "../../errors.js";
6	import logger, { LogId } from "../../logger.js";
7
8	export const DbOperationArgs = {	33✔
9	database: z.string().describe("Database name"),
10	collection: z.string().describe("Collection name"),
11	};
12
13	export abstract class MongoDBToolBase extends ToolBase {
14	protected category: ToolCategory = "mongodb";	600✔
15
16	protected async ensureConnected(): Promise<NodeDriverServiceProvider> {
17	if (!this.session.serviceProvider && this.config.connectionString) {	127✔
18	try {	19✔
19	await this.connectToMongoDB(this.config.connectionString);	19✔
20	} catch (error) {
21	logger.error(	×
22	LogId.mongodbConnectFailure,
23	"mongodbTool",
24	`Failed to connect to MongoDB instance using the connection string from the config: ${error as string}`
25	);
26	throw new MongoDBError(ErrorCodes.MisconfiguredConnectionString, "Not connected to MongoDB.");	×
27	}
28	}
29
30	if (!this.session.serviceProvider) {	127✔
31	throw new MongoDBError(ErrorCodes.NotConnectedToMongoDB, "Not connected to MongoDB");	19✔
32	}
33
34	return this.session.serviceProvider;	108✔
35	}
36
37	protected handleError(
38	error: unknown,
39	args: ToolArgs<typeof this.argsShape>
40	): Promise<CallToolResult> \| CallToolResult {
41	if (error instanceof MongoDBError) {	23✔
42	switch (error.code) {	19!
43	case ErrorCodes.NotConnectedToMongoDB:
44	return {	19✔
45	content: [
46	{
47	type: "text",
48	text: "You need to connect to a MongoDB instance before you can access its data.",
49	},
50	{
51	type: "text",
52	text: "Please use the 'connect' or 'switch-connection' tool to connect to a MongoDB instance.",
53	},
54	],
55	isError: true,
56	};
57	case ErrorCodes.MisconfiguredConnectionString:
58	return {	×
59	content: [
60	{
61	type: "text",
62	text: "The configured connection string is not valid. Please check the connection string and confirm it points to a valid MongoDB instance. Alternatively, use the 'switch-connection' tool to connect to a different instance.",
63	},
64	],
65	isError: true,
66	};
67	}
68	}
69
70	return super.handleError(error, args);	4✔
71	}
72
73	protected connectToMongoDB(connectionString: string): Promise<void> {
74	return this.session.connectToMongoDB(connectionString, this.config.connectOptions);	110✔
75	}
76
77	protected resolveTelemetryMetadata(
78	// eslint-disable-next-line @typescript-eslint/no-unused-vars
79	args: ToolArgs<typeof this.argsShape>
80	): TelemetryToolMetadata {
81	const metadata: TelemetryToolMetadata = {};	×
82
83	// Add projectId to the metadata if running a MongoDB operation to an Atlas cluster
84	if (this.session.connectedAtlasCluster?.projectId) {	×
85	metadata.projectId = this.session.connectedAtlasCluster.projectId;	×
86	}
87
88	return metadata;	×
89	}
90	}

mongodb-js / mongodb-mcp-server / 14993354207

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous