feat: Upgrade JS SDK to 9.16.1 and add durable objects instrumentation (#165)

AbhiPrasad · dcramer · web-flow · commit f19320e24eab · 2025-05-07T11:09:46.000-07:00
Durable objects instrumentation support was added in [9.16.0](https://github.com/getsentry/sentry-javascript/releases/tag/9.16.0) of the JS SDK. This PR upgrades `sentry-mcp` to get instrumented with durable objects. Docs PR for durable objects is here: getsentry/sentry-docs#13626. In `packages/mcp-cloudflare/src/server/lib/mcp-transport.ts` I had to comment out the `wrapMcpServerWithSentry` usage, because this breaks locally with miniflare. We're following up with the cloudflare team about this (more details here in linear: https://linear.app/getsentry/issue/JS-398/9150-breaks-cloudflare-sdk-usage-in-sentry-mcp#comment-7ce26edb). When we fix this, we'll come back and re-enable it. `9.16.0` also added support for logs in the Cloudflare SDK, so I enabled that, and added the `consoleLoggingIntegration` (integration is optional while logs is experimental in the SDK) to flush logs from `console.X` calls to Sentry. --------- Co-authored-by: David Cramer <dcramer@gmail.com>
diff --git a/packages/mcp-cloudflare/package.json b/packages/mcp-cloudflare/package.json
@@ -27,7 +27,7 @@
     "@cloudflare/workers-types": "^4.20250430.0",
     "@sentry/mcp-server": "workspace:*",
     "@sentry/mcp-server-tsconfig": "workspace:*",
-    "@sentry/vite-plugin": "^3.3.1",
+    "@sentry/vite-plugin": "^3.4.0",
     "@tailwindcss/typography": "^0.5.16",
     "@tailwindcss/vite": "^4.1.5",
     "@types/react": "^19.1.2",
@@ -43,9 +43,8 @@
     "@modelcontextprotocol/sdk": "^1.10.2",
     "@radix-ui/react-accordion": "^1.2.8",
     "@radix-ui/react-slot": "^1.2.0",
-    "@sentry/cloudflare": "9.14.0",
-    "@sentry/core": "9.14.0",
-    "@sentry/react": "9.14.0",
+    "@sentry/cloudflare": "9.16.1",
+    "@sentry/react": "9.16.1",
     "agents": "~0.0.75",
     "better-sqlite3": "^11.9.1",
     "class-variance-authority": "^0.7.1",
diff --git a/packages/mcp-cloudflare/src/server/index.ts b/packages/mcp-cloudflare/src/server/index.ts
@@ -1,9 +1,9 @@
+import * as Sentry from "@sentry/cloudflare";
 import OAuthProvider from "@cloudflare/workers-oauth-provider";
 import SentryMCP from "./lib/mcp-transport";
 import app from "./app";
 import { SCOPES } from "../constants";
 import type { Env } from "./types";
-import * as Sentry from "@sentry/cloudflare";
 
 // required for Durable Objects
 export { SentryMCP };
@@ -29,6 +29,10 @@ export default Sentry.withSentry(
     environment:
       env.SENTRY_ENVIRONMENT ??
       (process.env.NODE_ENV !== "production" ? "development" : "production"),
+    _experiments: {
+      enableLogs: true,
+    },
+    integrations: [Sentry.consoleLoggingIntegration()],
   }),
   oAuthProvider,
 ) satisfies ExportedHandler<Env>;
diff --git a/packages/mcp-cloudflare/src/server/lib/mcp-transport.ts b/packages/mcp-cloudflare/src/server/lib/mcp-transport.ts
@@ -1,20 +1,29 @@
+import * as Sentry from "@sentry/cloudflare";
 import { McpAgent } from "agents/mcp";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { configureServer } from "@sentry/mcp-server/server";
 import type { Env, WorkerProps } from "../types";
-import { flush } from "@sentry/cloudflare";
-import { wrapMcpServerWithSentry } from "@sentry/core";
 import { LIB_VERSION } from "@sentry/mcp-server/version";
 
 // Context from the auth process, encrypted & stored in the auth token
 // and provided to the DurableMCP as this.props
-export default class SentryMCP extends McpAgent<Env, unknown, WorkerProps> {
-  server = wrapMcpServerWithSentry(
-    new McpServer({
-      name: "Sentry MCP",
-      version: LIB_VERSION,
-    }),
-  );
+class SentryMCPBase extends McpAgent<Env, unknown, WorkerProps> {
+  server = new McpServer({
+    name: "Sentry MCP",
+    version: LIB_VERSION,
+  });
+  // Note: This does not work locally with miniflare so we are not using it
+  // server = wrapMcpServerWithSentry(
+  //   new McpServer({
+  //     name: "Sentry MCP",
+  //     version: LIB_VERSION,
+  //   }),
+  // );
+
+  // biome-ignore lint/complexity/noUselessConstructor: Need the constructor to match the durable object types.
+  constructor(state: DurableObjectState, env: Env) {
+    super(state, env);
+  }
 
   async init() {
     await configureServer({
@@ -25,8 +34,27 @@ export default class SentryMCP extends McpAgent<Env, unknown, WorkerProps> {
         userId: this.props.id,
       },
       onToolComplete: () => {
-        this.ctx.waitUntil(flush(2000));
+        this.ctx.waitUntil(Sentry.flush(2000));
       },
     });
   }
 }
+
+export default Sentry.instrumentDurableObjectWithSentry(
+  (env) => ({
+    dsn: env.SENTRY_DSN,
+    tracesSampleRate: 1,
+    sendDefaultPii: true,
+    initialScope: {
+      tags: {
+        durable_object: true,
+        mcp_server_version: LIB_VERSION,
+      },
+    },
+    _experiments: {
+      enableLogs: true,
+    },
+    integrations: [Sentry.consoleLoggingIntegration()],
+  }),
+  SentryMCPBase,
+);
diff --git a/packages/mcp-cloudflare/src/server/types.ts b/packages/mcp-cloudflare/src/server/types.ts
@@ -1,5 +1,4 @@
 import type { OAuthHelpers } from "@cloudflare/workers-oauth-provider";
-import type SentryMCP from "./lib/mcp-transport";
 import type { ServerContext } from "@sentry/mcp-server/types";
 
 export type WorkerProps = ServerContext & {
@@ -17,7 +16,7 @@ export interface Env {
   SENTRY_CLIENT_SECRET: string;
   SENTRY_DSN?: string;
   SENTRY_HOST?: string;
-  MCP_OBJECT: DurableObjectNamespace<SentryMCP>;
+  MCP_OBJECT: DurableObjectNamespace;
   OAUTH_PROVIDER: OAuthHelpers;
   AI: Ai;
 }
diff --git a/packages/mcp-server-tsconfig/package.json b/packages/mcp-server-tsconfig/package.json
@@ -2,8 +2,5 @@
   "name": "@sentry/mcp-server-tsconfig",
   "version": "0.5.0",
   "private": true,
-  "files": [
-    "tsconfig.base.json",
-    "tsconfig.vite.json"
-  ]
+  "files": ["tsconfig.base.json", "tsconfig.vite.json"]
 }
diff --git a/packages/mcp-server/package.json b/packages/mcp-server/package.json
@@ -13,9 +13,7 @@
   "author": "Sentry",
   "description": "Sentry MCP Server",
   "homepage": "https://github.com/getsentry/sentry-mcp",
-  "keywords": [
-    "sentry"
-  ],
+  "keywords": ["sentry"],
   "bugs": {
     "url": "https://github.com/getsentry/sentry-mcp/issues"
   },
@@ -26,9 +24,7 @@
   "bin": {
     "sentry-mcp": "./dist/index.js"
   },
-  "files": [
-    "./dist/*"
-  ],
+  "files": ["./dist/*"],
   "exports": {
     ".": {
       "types": "./dist/index.ts",
@@ -87,8 +83,8 @@
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.10.2",
-    "@sentry/core": "^9.14.0",
-    "@sentry/node": "^9.14.0",
+    "@sentry/core": "^9.16.1",
+    "@sentry/node": "^9.16.1",
     "zod": "^3.24.3"
   }
 }
diff --git a/packages/mcp-server/src/index.ts b/packages/mcp-server/src/index.ts
@@ -2,7 +2,6 @@
 
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { startStdio } from "./transports/stdio";
-import { wrapMcpServerWithSentry } from "@sentry/core";
 import * as Sentry from "@sentry/node";
 import { LIB_VERSION } from "./version";
 
@@ -46,6 +45,11 @@ if (!accessToken) {
 Sentry.init({
   dsn: sentryDsn,
   sendDefaultPii: true,
+  initialScope: {
+    tags: {
+      mcp_server_version: LIB_VERSION,
+    },
+  },
   environment:
     process.env.SENTRY_ENVIRONMENT ??
     (process.env.NODE_ENV !== "production" ? "development" : "production"),
@@ -56,7 +60,7 @@ const server = new McpServer({
   version: LIB_VERSION,
 });
 
-const instrumentedServer = wrapMcpServerWithSentry(server);
+const instrumentedServer = Sentry.wrapMcpServerWithSentry(server);
 
 const SENTRY_TIMEOUT = 5000; // 5 seconds
 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
