Merge branch 'main' into feat/save-to-file

Author: aberemia24

README.md

@@ -314,7 +314,7 @@ You can also run `npx chrome-devtools-mcp@latest --help` to see all available co
 data directory:
 
 - Linux / MacOS: `$HOME/.cache/chrome-devtools-mcp/chrome-profile-$CHANNEL`
-- Window: `%HOMEPATH%/.cache/chrome-devtools-mcp/chrome-profile-$CHANNEL`
+- Windows: `%HOMEPATH%/.cache/chrome-devtools-mcp/chrome-profile-$CHANNEL`
 
 The user data directory is not cleared between runs and shared across
 all instances of `chrome-devtools-mcp`. Set the `isolated` option to `true`

src/McpContext.ts

@@ -58,6 +58,18 @@ function getNetworkMultiplierFromString(condition: string | null): number {
   return 1;
 }
 
+function getExtensionFromMimeType(mimeType: string) {
+  switch (mimeType) {
+    case 'image/png':
+      return 'png';
+    case 'image/jpeg':
+      return 'jpeg';
+    case 'image/webp':
+      return 'webp';
+  }
+  throw new Error(`No mapping for Mime type ${mimeType}.`);
+}
+
 export class McpContext implements Context {
   browser: Browser;
   logger: Debugger;
@@ -346,18 +358,29 @@ export class McpContext implements Context {
       const dir = await fs.mkdtemp(
         path.join(os.tmpdir(), 'chrome-devtools-mcp-'),
       );
-      const ext =
-        mimeType === 'image/png'
-          ? 'png'
-          : mimeType === 'image/jpeg'
-            ? 'jpg'
-            : 'webp';
-      const filename = path.join(dir, `screenshot.${ext}`);
+
+      const filename = path.join(
+        dir,
+        `screenshot.${getExtensionFromMimeType(mimeType)}`,
+      );
       await fs.writeFile(filename, data);
       return {filename};
     } catch (err) {
       this.logger(err);
-      throw new Error('Could not save a screenshot to a file');
+      throw new Error('Could not save a screenshot to a file', {cause: err});
+    }
+  }
+  async saveFile(
+    data: Uint8Array<ArrayBufferLike>,
+    filename: string,
+  ): Promise<{filename: string}> {
+    try {
+      const filePath = path.resolve(filename);
+      await fs.writeFile(filePath, data);
+      return {filename};
+    } catch (err) {
+      this.logger(err);
+      throw new Error('Could not save a screenshot to a file', {cause: err});
     }
   }
 

src/McpResponse.ts

@@ -210,30 +210,12 @@ Call ${handleDialog.name} to handle it before continuing.`);
 
       response.push('## Network requests');
       if (requests.length) {
-        const paginationResult = paginate(
+        const data = this.#dataWithPagination(
           requests,
           this.#networkRequestsOptions.pagination,
         );
-        if (paginationResult.invalidPage) {
-          response.push('Invalid page number provided. Showing first page.');
-        }
-
-        const {startIndex, endIndex, currentPage, totalPages} =
-          paginationResult;
-        response.push(
-          `Showing ${startIndex + 1}-${endIndex} of ${requests.length} (Page ${currentPage + 1} of ${totalPages}).`,
-        );
-
-        if (this.#networkRequestsOptions.pagination) {
-          if (paginationResult.hasNextPage) {
-            response.push(`Next page: ${currentPage + 1}`);
-          }
-          if (paginationResult.hasPreviousPage) {
-            response.push(`Previous page: ${currentPage - 1}`);
-          }
-        }
-
-        for (const request of paginationResult.items) {
+        response.push(...data.info);
+        for (const request of data.items) {
           response.push(getShortDescriptionForRequest(request));
         }
       } else {
@@ -264,6 +246,32 @@ Call ${handleDialog.name} to handle it before continuing.`);
     return [text, ...images];
   }
 
+  #dataWithPagination<T>(data: T[], pagination?: PaginationOptions) {
+    const response = [];
+    const paginationResult = paginate<T>(data, pagination);
+    if (paginationResult.invalidPage) {
+      response.push('Invalid page number provided. Showing first page.');
+    }
+
+    const {startIndex, endIndex, currentPage, totalPages} = paginationResult;
+    response.push(
+      `Showing ${startIndex + 1}-${endIndex} of ${data.length} (Page ${currentPage + 1} of ${totalPages}).`,
+    );
+    if (pagination) {
+      if (paginationResult.hasNextPage) {
+        response.push(`Next page: ${currentPage + 1}`);
+      }
+      if (paginationResult.hasPreviousPage) {
+        response.push(`Previous page: ${currentPage - 1}`);
+      }
+    }
+
+    return {
+      info: response,
+      items: paginationResult.items,
+    };
+  }
+
   #getIncludeNetworkRequestsData(context: McpContext): string[] {
     const response: string[] = [];
     const url = this.#attachedNetworkRequestUrl;

src/tools/ToolDefinition.ts

@@ -75,6 +75,10 @@ export type Context = Readonly<{
     data: Uint8Array<ArrayBufferLike>,
     mimeType: 'image/png' | 'image/jpeg' | 'image/webp',
   ): Promise<{filename: string}>;
+  saveFile(
+    data: Uint8Array<ArrayBufferLike>,
+    filename: string,
+  ): Promise<{filename: string}>;
   waitForEventsAfterAction(action: () => Promise<unknown>): Promise<void>;
   createTextSnapshot(): Promise<void>;
   getTextSnapshot(): TextSnapshot | null;

src/tools/screenshot.ts

@@ -4,8 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {writeFile} from 'node:fs/promises';
-
 import type {ElementHandle, Page} from 'puppeteer-core';
 import z from 'zod';
 
@@ -85,10 +83,8 @@ export const screenshot = defineTool({
     }
 
     if (request.params.filePath) {
-      await writeFile(request.params.filePath, screenshot);
-      response.appendResponseLine(
-        `Saved screenshot to ${request.params.filePath}.`,
-      );
+      const file = await context.saveFile(screenshot, request.params.filePath);
+      response.appendResponseLine(`Saved screenshot to ${file.filename}.`);
     } else if (screenshot.length >= 2_000_000) {
       const {filename} = await context.saveTemporaryFile(
         screenshot,