Add event attachment download support (#358)

dcramer · seanhoughton · web-flow · commit 83114806961c · 2025-07-08T14:18:20.000-07:00
Attachments can be listed and downloaded. Text attachments are returned inline with the text response. Binary attachments are included as embedded resource.

Co-authored-by: Sean Houghton &lt;sean.houghton@gmail.com&gt;
diff --git a/packages/mcp-server-mocks/src/fixtures/event-attachments.json b/packages/mcp-server-mocks/src/fixtures/event-attachments.json
@@ -0,0 +1,14 @@
+[
+  {
+    "id": "123",
+    "name": "screenshot.png",
+    "type": "event.attachment",
+    "size": 1024,
+    "mimetype": "image/png",
+    "dateCreated": "2025-04-08T21:15:04.000Z",
+    "sha1": "abc123def456",
+    "headers": {
+      "Content-Type": "image/png"
+    }
+  }
+]
diff --git a/packages/mcp-server-mocks/src/index.ts b/packages/mcp-server-mocks/src/index.ts
@@ -27,6 +27,7 @@ import { http, HttpResponse } from "msw";
 import autofixStateFixture from "./fixtures/autofix-state.json";
 import issueFixture from "./fixtures/issue.json";
 import eventsFixture from "./fixtures/event.json";
+import eventAttachmentsFixture from "./fixtures/event-attachments.json";
 import tagsFixture from "./fixtures/tags.json";
 import projectFixture from "./fixtures/project.json";
 import teamFixture from "./fixtures/team.json";
@@ -897,6 +898,25 @@ export const restHandlers = buildHandlers([
       return HttpResponse.json(updatedIssue);
     },
   },
+  // Event attachment endpoints
+  {
+    method: "get",
+    path: "/api/0/projects/sentry-mcp-evals/cloudflare-mcp/events/7ca573c0f4814912aaa9bdc77d1a7d51/attachments/",
+    fetch: () => HttpResponse.json(eventAttachmentsFixture),
+  },
+  {
+    method: "get",
+    path: "/api/0/projects/sentry-mcp-evals/cloudflare-mcp/events/7ca573c0f4814912aaa9bdc77d1a7d51/attachments/123/",
+    fetch: () => {
+      // Mock attachment blob response
+      const mockBlob = new Blob(["fake image data"], { type: "image/png" });
+      return new HttpResponse(mockBlob, {
+        headers: {
+          "Content-Type": "image/png",
+        },
+      });
+    },
+  },
 ]);
 
 // Add handlers for mcp.sentry.dev and localhost
diff --git a/packages/mcp-server/package.json b/packages/mcp-server/package.json
@@ -79,8 +79,8 @@
     "dev": "pnpm run generate-tool-definitions && tsc -w",
     "start": "tsx src/index.ts",
     "prepare": "pnpm run build",
-    "test": "vitest",
-    "test:ci": "vitest run --coverage --reporter=junit --outputFile=tests.junit.xml",
+    "test": "pnpm run generate-tool-definitions && vitest",
+    "test:ci": "pnpm run generate-tool-definitions && vitest run --coverage --reporter=junit --outputFile=tests.junit.xml",
     "tsc": "tsc --noEmit",
     "test:watch": "vitest watch",
     "generate-tool-definitions": "tsx scripts/generate-tool-definitions.ts"
diff --git a/packages/mcp-server/src/api-client/client.ts b/packages/mcp-server/src/api-client/client.ts
@@ -9,6 +9,8 @@ import {
   IssueListSchema,
   IssueSchema,
   EventSchema,
+  EventAttachmentListSchema,
+  EventAttachmentSchema,
   ErrorsSearchResponseSchema,
   SpansSearchResponseSchema,
   TagListSchema,
@@ -25,6 +27,8 @@ import type {
   ClientKey,
   ClientKeyList,
   Event,
+  EventAttachment,
+  EventAttachmentList,
   Issue,
   IssueList,
   OrganizationList,
@@ -871,6 +875,86 @@ export class SentryApiService {
     );
   }
 
+  async listEventAttachments(
+    {
+      organizationSlug,
+      projectSlug,
+      eventId,
+    }: {
+      organizationSlug: string;
+      projectSlug: string;
+      eventId: string;
+    },
+    opts?: RequestOptions,
+  ) {
+    const response = await this.request(
+      `/projects/${organizationSlug}/${projectSlug}/events/${eventId}/attachments/`,
+      undefined,
+      opts,
+    );
+
+    const body = await response.json();
+    return EventAttachmentListSchema.parse(body);
+  }
+
+  async getEventAttachment(
+    {
+      organizationSlug,
+      projectSlug,
+      eventId,
+      attachmentId,
+    }: {
+      organizationSlug: string;
+      projectSlug: string;
+      eventId: string;
+      attachmentId: string;
+    },
+    opts?: RequestOptions,
+  ): Promise<{
+    attachment: any;
+    downloadUrl: string;
+    filename: string;
+    blob: Blob;
+  }> {
+    // Get the attachment metadata first
+    const attachmentsResponse = await this.request(
+      `/projects/${organizationSlug}/${projectSlug}/events/${eventId}/attachments/`,
+      undefined,
+      opts,
+    );
+
+    const attachments = EventAttachmentListSchema.parse(
+      await attachmentsResponse.json(),
+    );
+    const attachment = attachments.find((att) => att.id === attachmentId);
+
+    if (!attachment) {
+      throw new Error(
+        `Attachment with ID ${attachmentId} not found for event ${eventId}`,
+      );
+    }
+
+    // Download the actual file content
+    const downloadUrl = `/projects/${organizationSlug}/${projectSlug}/events/${eventId}/attachments/${attachmentId}/?download=1`;
+    const downloadResponse = await this.request(
+      downloadUrl,
+      {
+        method: "GET",
+        headers: {
+          Accept: "application/octet-stream",
+        },
+      },
+      opts,
+    );
+
+    return {
+      attachment,
+      downloadUrl: downloadResponse.url,
+      filename: attachment.name,
+      blob: await downloadResponse.blob(),
+    };
+  }
+
   async updateIssue(
     {
       organizationSlug,
diff --git a/packages/mcp-server/src/api-client/schema.ts b/packages/mcp-server/src/api-client/schema.ts
@@ -533,3 +533,16 @@ export const AutofixRunStateSchema = z.object({
     .passthrough()
     .nullable(),
 });
+
+export const EventAttachmentSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  type: z.string(),
+  size: z.number(),
+  mimetype: z.string(),
+  dateCreated: z.string().datetime(),
+  sha1: z.string(),
+  headers: z.record(z.string(), z.string()).optional(),
+});
+
+export const EventAttachmentListSchema = z.array(EventAttachmentSchema);
diff --git a/packages/mcp-server/src/api-client/types.ts b/packages/mcp-server/src/api-client/types.ts
@@ -46,6 +46,8 @@ import type {
   ClientKeyListSchema,
   ClientKeySchema,
   EventSchema,
+  EventAttachmentSchema,
+  EventAttachmentListSchema,
   IssueListSchema,
   IssueSchema,
   OrganizationListSchema,
@@ -69,6 +71,7 @@ export type ClientKey = z.infer<typeof ClientKeySchema>;
 export type Release = z.infer<typeof ReleaseSchema>;
 export type Issue = z.infer<typeof IssueSchema>;
 export type Event = z.infer<typeof EventSchema>;
+export type EventAttachment = z.infer<typeof EventAttachmentSchema>;
 export type Tag = z.infer<typeof TagSchema>;
 export type AutofixRun = z.infer<typeof AutofixRunSchema>;
 export type AutofixRunState = z.infer<typeof AutofixRunStateSchema>;
@@ -79,5 +82,6 @@ export type TeamList = z.infer<typeof TeamListSchema>;
 export type ProjectList = z.infer<typeof ProjectListSchema>;
 export type ReleaseList = z.infer<typeof ReleaseListSchema>;
 export type IssueList = z.infer<typeof IssueListSchema>;
+export type EventAttachmentList = z.infer<typeof EventAttachmentListSchema>;
 export type TagList = z.infer<typeof TagListSchema>;
 export type ClientKeyList = z.infer<typeof ClientKeyListSchema>;
diff --git a/packages/mcp-server/src/schema.ts b/packages/mcp-server/src/schema.ts
@@ -114,3 +114,10 @@ export const ParamSentryGuide = z
     "Optional guide filter to limit search results to specific documentation sections. " +
       "Use either a platform (e.g., 'javascript', 'python') or platform/guide combination (e.g., 'javascript/nextjs', 'python/django').",
   );
+
+export const ParamEventId = z.string().trim().describe("The ID of the event.");
+
+export const ParamAttachmentId = z
+  .string()
+  .trim()
+  .describe("The ID of the attachment to download.");
diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts
@@ -300,9 +300,9 @@ export async function configureServer({
                   return {
                     messages: [
                       {
-                        role: "user",
+                        role: "user" as const,
                         content: {
-                          type: "text",
+                          type: "text" as const,
                           text: output,
                         },
                       },
@@ -361,14 +361,24 @@ export async function configureServer({
                   span.setStatus({
                     code: 1, // ok
                   });
-                  return {
-                    content: [
-                      {
-                        type: "text" as const,
-                        text: String(output),
-                      },
-                    ],
-                  };
+                  // if the tool returns a string, assume it's a message
+                  if (typeof output === "string") {
+                    return {
+                      content: [
+                        {
+                          type: "text" as const,
+                          text: output,
+                        },
+                      ],
+                    };
+                  }
+                  // if the tool returns a list, assume it's a content list
+                  if (Array.isArray(output)) {
+                    return {
+                      content: output,
+                    };
+                  }
+                  throw new Error(`Invalid tool output: ${output}`);
                 } catch (error) {
                   span.setStatus({
                     code: 2, // error
diff --git a/packages/mcp-server/src/tools/get-event-attachment.test.ts b/packages/mcp-server/src/tools/get-event-attachment.test.ts
@@ -0,0 +1,117 @@
+import { describe, it, expect } from "vitest";
+import getEventAttachment from "./get-event-attachment.js";
+
+describe("get_event_attachment", () => {
+  it("lists attachments for an event", async () => {
+    const result = await getEventAttachment.handler(
+      {
+        organizationSlug: "sentry-mcp-evals",
+        projectSlug: "cloudflare-mcp",
+        eventId: "7ca573c0f4814912aaa9bdc77d1a7d51",
+        attachmentId: undefined,
+        regionUrl: undefined,
+      },
+      {
+        accessToken: "access-token",
+        userId: "1",
+        organizationSlug: null,
+      },
+    );
+    expect(result).toMatchInlineSnapshot(`
+      "# Event Attachments
+
+      **Event ID:** 7ca573c0f4814912aaa9bdc77d1a7d51
+      **Project:** cloudflare-mcp
+
+      Found 1 attachment(s):
+
+      ## Attachment 1
+
+      **ID:** 123
+      **Name:** screenshot.png
+      **Type:** event.attachment
+      **Size:** 1024 bytes
+      **MIME Type:** image/png
+      **Created:** 2025-04-08T21:15:04.000Z
+      **SHA1:** abc123def456
+
+      To download this attachment, use the "get_event_attachment" tool with the attachmentId provided:
+      \`get_event_attachment(organizationSlug="sentry-mcp-evals", projectSlug="cloudflare-mcp", eventId="7ca573c0f4814912aaa9bdc77d1a7d51", attachmentId="123")\`
+
+      "
+    `);
+  });
+
+  it("downloads a specific attachment by ID", async () => {
+    const result = await getEventAttachment.handler(
+      {
+        organizationSlug: "sentry-mcp-evals",
+        projectSlug: "cloudflare-mcp",
+        eventId: "7ca573c0f4814912aaa9bdc77d1a7d51",
+        attachmentId: "123",
+        regionUrl: undefined,
+      },
+      {
+        accessToken: "access-token",
+        userId: "1",
+        organizationSlug: null,
+      },
+    );
+
+    // Should return an array with both text description and image content
+    expect(Array.isArray(result)).toBe(true);
+    expect(result).toHaveLength(2);
+
+    // First item should be the image content
+    expect(result[0]).toMatchObject({
+      type: "image",
+      mimeType: "image/png",
+      data: expect.any(String), // base64 encoded data
+    });
+
+    // Second item should be the text description
+    expect(result[1]).toMatchInlineSnapshot(`
+      {
+        "text": "# Event Attachment Download
+
+      **Event ID:** 7ca573c0f4814912aaa9bdc77d1a7d51
+      **Attachment ID:** 123
+      **Filename:** screenshot.png
+      **Type:** event.attachment
+      **Size:** 1024 bytes
+      **MIME Type:** image/png
+      **Created:** 2025-04-08T21:15:04.000Z
+      **SHA1:** abc123def456
+
+      **Download URL:** https://sentry.io/api/0/projects/sentry-mcp-evals/cloudflare-mcp/events/7ca573c0f4814912aaa9bdc77d1a7d51/attachments/123/?download=1
+
+      ## Binary Content
+
+      The attachment is included as a resource and accessible through your client.
+      ",
+        "type": "text",
+      }
+    `);
+  });
+
+  it("throws error for malformed regionUrl", async () => {
+    await expect(
+      getEventAttachment.handler(
+        {
+          organizationSlug: "sentry-mcp-evals",
+          projectSlug: "cloudflare-mcp",
+          eventId: "7ca573c0f4814912aaa9bdc77d1a7d51",
+          attachmentId: undefined,
+          regionUrl: "https",
+        },
+        {
+          accessToken: "access-token",
+          userId: "1",
+          organizationSlug: null,
+        },
+      ),
+    ).rejects.toThrow(
+      "Invalid regionUrl provided: https. Must be a valid URL.",
+    );
+  });
+});
diff --git a/packages/mcp-server/src/tools/get-event-attachment.ts b/packages/mcp-server/src/tools/get-event-attachment.ts
diff --git a/packages/mcp-server/src/tools/index.ts b/packages/mcp-server/src/tools/index.ts
diff --git a/packages/mcp-server/src/tools/types.ts b/packages/mcp-server/src/tools/types.ts
diff --git a/packages/mcp-server/src/types.ts b/packages/mcp-server/src/types.ts
