chore: add hints and update mcp (#249)

Author: blva

package-lock.json

@@ -60,7 +60,7 @@
     "yaml": "^2.7.1"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.8.0",
+    "@modelcontextprotocol/sdk": "^1.11.2",
     "@mongodb-js/device-id": "^0.2.1",
     "@mongodb-js/devtools-connect": "^3.7.2",
     "@mongosh/service-provider-node-driver": "^3.6.0",

package.json

@@ -34,7 +34,9 @@ export class ApiClient {
 
     private getAccessToken = async () => {
         if (this.oauth2Client && (!this.accessToken || this.accessToken.expired())) {
-            this.accessToken = await this.oauth2Client.getToken({});
+            this.accessToken = await this.oauth2Client.getToken({
+                agent: this.options.userAgent,
+            });
         }
         return this.accessToken?.token.access_token as string | undefined;
     };

src/common/atlas/apiClient.ts

@@ -7,7 +7,6 @@ export class ListDatabasesTool extends MongoDBToolBase {
     protected name = "list-databases";
     protected description = "List all databases for a MongoDB connection";
     protected argsShape = {};
-
     protected operationType: OperationType = "metadata";
 
     protected async execute(): Promise<CallToolResult> {

src/tools/mongodb/metadata/listDatabases.ts

@@ -1,6 +1,6 @@
 import { z, type ZodRawShape, type ZodNever, AnyZodObject } from "zod";
 import type { McpServer, RegisteredTool, ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type { CallToolResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
 import { Session } from "../session.js";
 import logger, { LogId } from "../logger.js";
 import { Telemetry } from "../telemetry/telemetry.js";
@@ -27,6 +27,34 @@ export abstract class ToolBase {
 
     protected abstract argsShape: ZodRawShape;
 
+    protected get annotations(): ToolAnnotations {
+        const annotations: ToolAnnotations = {
+            title: this.name,
+            description: this.description,
+        };
+
+        switch (this.operationType) {
+            case "read":
+            case "metadata":
+                annotations.readOnlyHint = true;
+                annotations.destructiveHint = false;
+                break;
+            case "delete":
+                annotations.readOnlyHint = false;
+                annotations.destructiveHint = true;
+                break;
+            case "create":
+            case "update":
+                annotations.destructiveHint = false;
+                annotations.readOnlyHint = false;
+                break;
+            default:
+                break;
+        }
+
+        return annotations;
+    }
+
     protected abstract execute(...args: Parameters<ToolCallback<typeof this.argsShape>>): Promise<CallToolResult>;
 
     constructor(
@@ -56,7 +84,7 @@ export abstract class ToolBase {
             }
         };
 
-        server.tool(this.name, this.description, this.argsShape, callback);
+        server.tool(this.name, this.description, this.argsShape, this.annotations, callback);
 
         // This is very similar to RegisteredTool.update, but without the bugs around the name.
         // In the upstream update method, the name is captured in the closure and not updated when
@@ -65,14 +93,17 @@ export abstract class ToolBase {
         this.update = (updates: { name?: string; description?: string; inputSchema?: AnyZodObject }) => {
             const tools = server["_registeredTools"] as { [toolName: string]: RegisteredTool };
             const existingTool = tools[this.name];
+            existingTool.annotations = this.annotations;
 
             if (updates.name && updates.name !== this.name) {
+                existingTool.annotations.title = updates.name;
                 delete tools[this.name];
                 this.name = updates.name;
                 tools[this.name] = existingTool;
             }
 
             if (updates.description) {
+                existingTool.annotations.description = updates.description;
                 existingTool.description = updates.description;
                 this.description = updates.description;
             }

src/tools/tool.ts

@@ -206,6 +206,7 @@ export function validateToolMetadata(
         expectDefined(tool);
         expect(tool.description).toBe(description);
 
+        validateToolAnnotations(tool, name, description);
         const toolParameters = getParameters(tool);
         expect(toolParameters).toHaveLength(parameters.length);
         expect(toolParameters).toIncludeAllMembers(parameters);
@@ -240,3 +241,25 @@ export function expectDefined<T>(arg: T): asserts arg is Exclude<T, undefined |
     expect(arg).toBeDefined();
     expect(arg).not.toBeNull();
 }
+
+function validateToolAnnotations(tool: ToolInfo, name: string, description: string): void {
+    expectDefined(tool.annotations);
+    expect(tool.annotations.title).toBe(name);
+    expect(tool.annotations.description).toBe(description);
+
+    switch (tool.operationType) {
+        case "read":
+        case "metadata":
+            expect(tool.annotations.readOnlyHint).toBe(true);
+            expect(tool.annotations.destructiveHint).toBe(false);
+            break;
+        case "delete":
+            expect(tool.annotations.readOnlyHint).toBe(false);
+            expect(tool.annotations.destructiveHint).toBe(true);
+            break;
+        case "create":
+        case "update":
+            expect(tool.annotations.readOnlyHint).toBe(false);
+            expect(tool.annotations.destructiveHint).toBe(false);
+    }
+}