feat(core): Associate resource/tool/prompt invocations with request span instead of response span (#16126)

Author: lforst

dev-packages/e2e-tests/test-applications/node-express/package.json

@@ -11,6 +11,7 @@
     "test:assert": "pnpm test"
   },
   "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.10.2",
     "@sentry/core": "latest || *",
     "@sentry/node": "latest || *",
     "@trpc/server": "10.45.2",
@@ -19,7 +20,7 @@
     "@types/node": "^18.19.1",
     "express": "^4.21.2",
     "typescript": "~5.0.0",
-    "zod": "~3.22.4"
+    "zod": "~3.24.3"
   },
   "devDependencies": {
     "@playwright/test": "~1.50.0",

dev-packages/e2e-tests/test-applications/node-express/src/app.ts

@@ -19,10 +19,13 @@ import { TRPCError, initTRPC } from '@trpc/server';
 import * as trpcExpress from '@trpc/server/adapters/express';
 import express from 'express';
 import { z } from 'zod';
+import { mcpRouter } from './mcp';
 
 const app = express();
 const port = 3030;
 
+app.use(mcpRouter);
+
 app.get('/test-success', function (req, res) {
   res.send({ version: 'v1' });
 });

dev-packages/e2e-tests/test-applications/node-express/src/mcp.ts

@@ -0,0 +1,64 @@
+import express from 'express';
+import { McpServer, ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { SSEServerTransport } from '@modelcontextprotocol/sdk/server/sse.js';
+import { z } from 'zod';
+import { wrapMcpServerWithSentry } from '@sentry/core';
+
+const mcpRouter = express.Router();
+
+const server = wrapMcpServerWithSentry(
+  new McpServer({
+    name: 'Echo',
+    version: '1.0.0',
+  }),
+);
+
+server.resource('echo', new ResourceTemplate('echo://{message}', { list: undefined }), async (uri, { message }) => ({
+  contents: [
+    {
+      uri: uri.href,
+      text: `Resource echo: ${message}`,
+    },
+  ],
+}));
+
+server.tool('echo', { message: z.string() }, async ({ message }, rest) => {
+  return {
+    content: [{ type: 'text', text: `Tool echo: ${message}` }],
+  };
+});
+
+server.prompt('echo', { message: z.string() }, ({ message }, extra) => ({
+  messages: [
+    {
+      role: 'user',
+      content: {
+        type: 'text',
+        text: `Please process this message: ${message}`,
+      },
+    },
+  ],
+}));
+
+const transports: Record<string, SSEServerTransport> = {};
+
+mcpRouter.get('/sse', async (_, res) => {
+  const transport = new SSEServerTransport('/messages', res);
+  transports[transport.sessionId] = transport;
+  res.on('close', () => {
+    delete transports[transport.sessionId];
+  });
+  await server.connect(transport);
+});
+
+mcpRouter.post('/messages', async (req, res) => {
+  const sessionId = req.query.sessionId;
+  const transport = transports[sessionId as string];
+  if (transport) {
+    await transport.handlePostMessage(req, res);
+  } else {
+    res.status(400).send('No transport found for sessionId');
+  }
+});
+
+export { mcpRouter };

dev-packages/e2e-tests/test-applications/node-express/tests/mcp.test.ts

@@ -0,0 +1,109 @@
+import { expect, test } from '@playwright/test';
+import { waitForTransaction } from '@sentry-internal/test-utils';
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+import { SSEClientTransport } from '@modelcontextprotocol/sdk/client/sse.js';
+
+test('Should record transactions for mcp handlers', async ({ baseURL }) => {
+  const transport = new SSEClientTransport(new URL(`${baseURL}/sse`));
+
+  const client = new Client({
+    name: 'test-client',
+    version: '1.0.0',
+  });
+
+  await client.connect(transport);
+
+  await test.step('tool handler', async () => {
+    const postTransactionPromise = waitForTransaction('node-express', transactionEvent => {
+      return transactionEvent.transaction === 'POST /messages';
+    });
+    const toolTransactionPromise = waitForTransaction('node-express', transactionEvent => {
+      return transactionEvent.transaction === 'mcp-server/tool:echo';
+    });
+
+    const toolResult = await client.callTool({
+      name: 'echo',
+      arguments: {
+        message: 'foobar',
+      },
+    });
+
+    expect(toolResult).toMatchObject({
+      content: [
+        {
+          text: 'Tool echo: foobar',
+          type: 'text',
+        },
+      ],
+    });
+
+    const postTransaction = await postTransactionPromise;
+    expect(postTransaction).toBeDefined();
+
+    const toolTransaction = await toolTransactionPromise;
+    expect(toolTransaction).toBeDefined();
+
+    // TODO: When https://github.com/modelcontextprotocol/typescript-sdk/pull/358 is released check for trace id equality between the post transaction and the handler transaction
+  });
+
+  await test.step('resource handler', async () => {
+    const postTransactionPromise = waitForTransaction('node-express', transactionEvent => {
+      return transactionEvent.transaction === 'POST /messages';
+    });
+    const resourceTransactionPromise = waitForTransaction('node-express', transactionEvent => {
+      return transactionEvent.transaction === 'mcp-server/resource:echo';
+    });
+
+    const resourceResult = await client.readResource({
+      uri: 'echo://foobar',
+    });
+
+    expect(resourceResult).toMatchObject({
+      contents: [{ text: 'Resource echo: foobar', uri: 'echo://foobar' }],
+    });
+
+    const postTransaction = await postTransactionPromise;
+    expect(postTransaction).toBeDefined();
+
+    const resourceTransaction = await resourceTransactionPromise;
+    expect(resourceTransaction).toBeDefined();
+
+    // TODO: When https://github.com/modelcontextprotocol/typescript-sdk/pull/358 is released check for trace id equality between the post transaction and the handler transaction
+  });
+
+  await test.step('prompt handler', async () => {
+    const postTransactionPromise = waitForTransaction('node-express', transactionEvent => {
+      return transactionEvent.transaction === 'POST /messages';
+    });
+    const promptTransactionPromise = waitForTransaction('node-express', transactionEvent => {
+      return transactionEvent.transaction === 'mcp-server/prompt:echo';
+    });
+
+    const promptResult = await client.getPrompt({
+      name: 'echo',
+      arguments: {
+        message: 'foobar',
+      },
+    });
+
+    expect(promptResult).toMatchObject({
+      messages: [
+        {
+          content: {
+            text: 'Please process this message: foobar',
+            type: 'text',
+          },
+          role: 'user',
+        },
+      ],
+    });
+
+    const postTransaction = await postTransactionPromise;
+    expect(postTransaction).toBeDefined();
+
+    const promptTransaction = await promptTransactionPromise;
+    expect(promptTransaction).toBeDefined();
+
+    // TODO: When https://github.com/modelcontextprotocol/typescript-sdk/pull/358 is released check for trace id equality between the post transaction and the handler transaction
+  });
+});

dev-packages/e2e-tests/test-applications/node-express/tsconfig.json

@@ -4,7 +4,8 @@
     "esModuleInterop": true,
     "lib": ["es2020"],
     "strict": true,
-    "outDir": "dist"
+    "outDir": "dist",
+    "skipLibCheck": true
   },
   "include": ["src/**/*.ts"]
 }