14652027781

Committed 24 Apr 2025 09:27PM UTC coverage: 85.897%. First build

Build # 14652027781

Build Type

Pull #115

github

Committed by

blva

Commit Message

Merge remote-tracking branch 'origin/main' into telemetry-data

Pull Request Pull Request #115: chore: add server events

Run Details

132 of 203 branches covered (65.02%)

Branch coverage included in aggregate %.

13 of 17 new or added lines in 1 file covered. (76.47%)

739 of 811 relevant lines covered (91.12%)

46.42 hits per line

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

85.96

/src/server.ts

import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { Session } from "./session.js";
import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
import { AtlasTools } from "./tools/atlas/tools.js";
import { MongoDbTools } from "./tools/mongodb/tools.js";
import logger, { initializeLogger } from "./logger.js";
import { mongoLogId } from "mongodb-log-writer";
import { ObjectId } from "mongodb";
import { Telemetry } from "./telemetry/telemetry.js";
import { UserConfig } from "./config.js";
import { type ServerEvent } from "./telemetry/types.js";
import { type ServerCommand } from "./telemetry/types.js";
import { CallToolRequestSchema, CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import assert from "assert";

export interface ServerOptions {
    session: Session;
    userConfig: UserConfig;
    mcpServer: McpServer;
}

export class Server {
    public readonly session: Session;
    private readonly mcpServer: McpServer;
    private readonly telemetry: Telemetry;
    private readonly userConfig: UserConfig;
    private readonly startTime: number;

    constructor({ session, mcpServer, userConfig }: ServerOptions) {
        this.startTime = Date.now();
        this.session = session;
        this.telemetry = new Telemetry(session);
        this.mcpServer = mcpServer;
        this.userConfig = userConfig;
    }

    async connect(transport: Transport) {
        this.mcpServer.server.registerCapabilities({ logging: {} });
        this.registerTools();
        this.registerResources();

        // This is a workaround for an issue we've seen with some models, where they'll see that everything in the `arguments`
        // object is optional, and then not pass it at all. However, the MCP server expects the `arguments` object to be if
        // the tool accepts any arguments, even if they're all optional.
        //
        // see: https://github.com/modelcontextprotocol/typescript-sdk/blob/131776764536b5fdca642df51230a3746fb4ade0/src/server/mcp.ts#L705
        // Since paramsSchema here is not undefined, the server will create a non-optional z.object from it.
        const existingHandler = (
            this.mcpServer.server["_requestHandlers"] as Map<
                string,
                (request: unknown, extra: unknown) => Promise<CallToolResult>
            >
        ).get(CallToolRequestSchema.shape.method.value);

        assert(existingHandler, "No existing handler found for CallToolRequestSchema");

        this.mcpServer.server.setRequestHandler(CallToolRequestSchema, (request, extra): Promise<CallToolResult> => {
            if (!request.params.arguments) {
                request.params.arguments = {};
            }

            return existingHandler(request, extra);
        });

        await initializeLogger(this.mcpServer, this.userConfig.logPath);

        await this.mcpServer.connect(transport);

        this.mcpServer.server.oninitialized = () => {
            this.session.setAgentRunner(this.mcpServer.server.getClientVersion());
            this.session.sessionId = new ObjectId().toString();

            logger.info(
                mongoLogId(1_000_004),
                "server",
                `Server started with transport ${transport.constructor.name} and agent runner ${this.session.agentRunner?.name}`
            );

            this.emitServerEvent("start", Date.now() - this.startTime);
        };

        this.mcpServer.server.onclose = () => {
            const closeTime = Date.now();
            this.emitServerEvent("stop", Date.now() - closeTime);
        };

        this.mcpServer.server.onerror = (error: Error) => {
            const closeTime = Date.now();
            this.emitServerEvent("stop", Date.now() - closeTime, error);
        };
    }

    async close(): Promise<void> {
        await this.session.close();
        await this.mcpServer.close();
    }

    /**
     * Emits a server event
     * @param command - The server command (e.g., "start", "stop", "register", "deregister")
     * @param additionalProperties - Additional properties specific to the event
     */
    emitServerEvent(command: ServerCommand, commandDuration: number, error?: Error) {
        const event: ServerEvent = {
            timestamp: new Date().toISOString(),
            source: "mdbmcp",
            properties: {
                ...this.telemetry.getCommonProperties(),
                result: "success",
                duration_ms: commandDuration,
                component: "server",
                category: "other",
                command: command,
            },
        };

        if (command === "start") {
            event.properties.startup_time_ms = commandDuration;
        }
        if (command === "stop") {
            event.properties.runtime_duration_ms = Date.now() - this.startTime;
            if (error) {
                event.properties.result = "failure";
                event.properties.reason = error.message;
            }
        }

        this.telemetry.emitEvents([event]).catch(() => {});
    }

    private registerTools() {
        for (const tool of [...AtlasTools, ...MongoDbTools]) {
            new tool(this.session, this.userConfig, this.telemetry).register(this.mcpServer);
        }
    }

    private registerResources() {
        if (this.userConfig.connectionString) {
            this.mcpServer.resource(
                "connection-string",
                "config://connection-string",
                {
                    description: "Preconfigured connection string that will be used as a default in the `connect` tool",
                },
                (uri) => {
                    return {
                        contents: [
                            {
                                text: `Preconfigured connection string: ${this.userConfig.connectionString}`,
                                uri: uri.href,
                            },
                        ],
                    };
                }
            );
        }
    }
}

1	import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2	import { Session } from "./session.js";
3	import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
4	import { AtlasTools } from "./tools/atlas/tools.js";	31✔
5	import { MongoDbTools } from "./tools/mongodb/tools.js";	31✔
6	import logger, { initializeLogger } from "./logger.js";	31✔
7	import { mongoLogId } from "mongodb-log-writer";	31✔
8	import { ObjectId } from "mongodb";	31✔
9	import { Telemetry } from "./telemetry/telemetry.js";	31✔
10	import { UserConfig } from "./config.js";
11	import { type ServerEvent } from "./telemetry/types.js";
12	import { type ServerCommand } from "./telemetry/types.js";
13	import { CallToolRequestSchema, CallToolResult } from "@modelcontextprotocol/sdk/types.js";	31✔
14	import assert from "assert";	31✔
15
16	export interface ServerOptions {
17	session: Session;
18	userConfig: UserConfig;
19	mcpServer: McpServer;
20	}
21
22	export class Server {	31✔
23	public readonly session: Session;
24	private readonly mcpServer: McpServer;
25	private readonly telemetry: Telemetry;
26	private readonly userConfig: UserConfig;
27	private readonly startTime: number;
28
29	constructor({ session, mcpServer, userConfig }: ServerOptions) {
30	this.startTime = Date.now();	27✔
31	this.session = session;	27✔
32	this.telemetry = new Telemetry(session);	27✔
33	this.mcpServer = mcpServer;	27✔
34	this.userConfig = userConfig;	27✔
35	}
36
37	async connect(transport: Transport) {
38	this.mcpServer.server.registerCapabilities({ logging: {} });	27✔
39	this.registerTools();	27✔
40	this.registerResources();	27✔
41
42	// This is a workaround for an issue we've seen with some models, where they'll see that everything in the `arguments`
43	// object is optional, and then not pass it at all. However, the MCP server expects the `arguments` object to be if
44	// the tool accepts any arguments, even if they're all optional.
45	//
46	// see: https://github.com/modelcontextprotocol/typescript-sdk/blob/131776764536b5fdca642df51230a3746fb4ade0/src/server/mcp.ts#L705
47	// Since paramsSchema here is not undefined, the server will create a non-optional z.object from it.
48	const existingHandler = (
49	this.mcpServer.server["_requestHandlers"] as Map<	27✔
50	string,
51	(request: unknown, extra: unknown) => Promise<CallToolResult>
52	>
53	).get(CallToolRequestSchema.shape.method.value);
54
55	assert(existingHandler, "No existing handler found for CallToolRequestSchema");	27✔
56
57	this.mcpServer.server.setRequestHandler(CallToolRequestSchema, (request, extra): Promise<CallToolResult> => {	27✔
58	if (!request.params.arguments) {	345✔
59	request.params.arguments = {};	2✔
60	}
61
62	return existingHandler(request, extra);	345✔
63	});
64
65	await initializeLogger(this.mcpServer, this.userConfig.logPath);	27✔
66
67	await this.mcpServer.connect(transport);	27✔
68
69	this.mcpServer.server.oninitialized = () => {	27✔
70	this.session.setAgentRunner(this.mcpServer.server.getClientVersion());	27✔
71	this.session.sessionId = new ObjectId().toString();	27✔
72
73	logger.info(	27✔
74	mongoLogId(1_000_004),
75	"server",
76	`Server started with transport ${transport.constructor.name} and agent runner ${this.session.agentRunner?.name}`
77	);
78
79	this.emitServerEvent("start", Date.now() - this.startTime);	27✔
80	};
81
82	this.mcpServer.server.onclose = () => {	27✔
83	const closeTime = Date.now();	27✔
84	this.emitServerEvent("stop", Date.now() - closeTime);	27✔
85	};
86
87	this.mcpServer.server.onerror = (error: Error) => {	27✔
NEW 88	const closeTime = Date.now();	×
NEW 89	this.emitServerEvent("stop", Date.now() - closeTime, error);	×
90	};
91	}
92
93	async close(): Promise<void> {
94	await this.session.close();	27✔
95	await this.mcpServer.close();	27✔
96	}
97
98	/**
99	* Emits a server event
100	* @param command - The server command (e.g., "start", "stop", "register", "deregister")
101	* @param additionalProperties - Additional properties specific to the event
102	*/
103	emitServerEvent(command: ServerCommand, commandDuration: number, error?: Error) {
104	const event: ServerEvent = {	54✔
105	timestamp: new Date().toISOString(),
106	source: "mdbmcp",
107	properties: {
108	...this.telemetry.getCommonProperties(),
109	result: "success",
110	duration_ms: commandDuration,
111	component: "server",
112	category: "other",
113	command: command,
114	},
115	};
116
117	if (command === "start") {	54✔
118	event.properties.startup_time_ms = commandDuration;	27✔
119	}
120	if (command === "stop") {	54✔
121	event.properties.runtime_duration_ms = Date.now() - this.startTime;	27✔
122	if (error) {	27!
NEW 123	event.properties.result = "failure";	×
NEW 124	event.properties.reason = error.message;	×
125	}
126	}
127
128	this.telemetry.emitEvents([event]).catch(() => {});	54✔
129	}
130
131	private registerTools() {
132	for (const tool of [...AtlasTools, ...MongoDbTools]) {	27✔
133	new tool(this.session, this.userConfig, this.telemetry).register(this.mcpServer);	810✔
134	}
135	}
136
137	private registerResources() {
138	if (this.userConfig.connectionString) {	27!
139	this.mcpServer.resource(	×
140	"connection-string",
141	"config://connection-string",
142	{
143	description: "Preconfigured connection string that will be used as a default in the `connect` tool",
144	},
145	(uri) => {
146	return {	×
147	contents: [
148	{
149	text: `Preconfigured connection string: ${this.userConfig.connectionString}`,
150	uri: uri.href,
151	},
152	],
153	};
154	}
155	);
156	}
157	}
158	}

mongodb-js / mongodb-mcp-server / 14652027781

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