add filters and pagination to the console messages tool

AlinaVarkki · AlinaVarkki · commit f6e67b435f0a · 2025-10-15T11:09:13.000+02:00
diff --git a/src/McpResponse.ts b/src/McpResponse.ts
@@ -33,15 +33,18 @@ export class McpResponse implements Response {
   #includePages = false;
   #includeSnapshot = false;
   #attachedNetworkRequestData?: NetworkRequestData;
-  #includeConsoleData = false;
   #textResponseLines: string[] = [];
-  #formattedConsoleData?: string[];
   #images: ImageContentData[] = [];
   #networkRequestsOptions?: {
     include: boolean;
     pagination?: PaginationOptions;
     resourceTypes?: ResourceType[];
   };
+  #consoleDataOptions?: {
+    include: boolean;
+    pagination?: PaginationOptions;
+    types?: string[];
+  };
 
   setIncludePages(value: boolean): void {
     this.#includePages = value;
@@ -77,8 +80,30 @@ export class McpResponse implements Response {
     };
   }
 
-  setIncludeConsoleData(value: boolean): void {
-    this.#includeConsoleData = value;
+  setIncludeConsoleData(
+    value: boolean,
+    options?: {
+      pageSize?: number;
+      pageIdx?: number;
+      types?: string[];
+    },
+  ): void {
+    if (!value) {
+      this.#consoleDataOptions = undefined;
+      return;
+    }
+
+    this.#consoleDataOptions = {
+      include: value,
+      pagination:
+        options?.pageSize || options?.pageIdx
+          ? {
+              pageSize: options.pageSize,
+              pageIdx: options.pageIdx,
+            }
+          : undefined,
+      types: options?.types,
+    };
   }
 
   attachNetworkRequest(reqid: number): void {
@@ -96,14 +121,20 @@ export class McpResponse implements Response {
   }
 
   get includeConsoleData(): boolean {
-    return this.#includeConsoleData;
+    return this.#consoleDataOptions?.include ?? false;
   }
   get attachedNetworkRequestId(): number | undefined {
     return this.#attachedNetworkRequestData?.networkRequestStableId;
   }
   get networkRequestsPageIdx(): number | undefined {
     return this.#networkRequestsOptions?.pagination?.pageIdx;
   }
+  get consoleMessagesPageIdx(): number | undefined {
+    return this.#consoleDataOptions?.pagination?.pageIdx;
+  }
+  get consoleMessagesTypes(): string[] | undefined {
+    return this.#consoleDataOptions?.types;
+  }
 
   appendResponseLine(value: string): void {
     this.#textResponseLines.push(value);
@@ -136,8 +167,6 @@ export class McpResponse implements Response {
       await context.createTextSnapshot();
     }
 
-    let formattedConsoleMessages: string[];
-
     if (this.#attachedNetworkRequestData?.networkRequestStableId) {
       const request = context.getNetworkRequestById(
         this.#attachedNetworkRequestData.networkRequestStableId,
@@ -153,23 +182,13 @@ export class McpResponse implements Response {
       }
     }
 
-    if (this.#includeConsoleData) {
-      const consoleMessages = context.getConsoleData();
-      if (consoleMessages) {
-        formattedConsoleMessages = await Promise.all(
-          consoleMessages.map(message => formatConsoleEvent(message)),
-        );
-        this.#formattedConsoleData = formattedConsoleMessages;
-      }
-    }
-
-    return this.format(toolName, context);
+    return await this.format(toolName, context);
   }
 
-  format(
+  async format(
     toolName: string,
     context: McpContext,
-  ): Array<TextContent | ImageContent> {
+  ): Promise<Array<TextContent | ImageContent>> {
     const response = [`# ${toolName} response`];
     for (const line of this.#textResponseLines) {
       response.push(line);
@@ -258,10 +277,32 @@ Call ${handleDialog.name} to handle it before continuing.`);
       }
     }
 
-    if (this.#includeConsoleData && this.#formattedConsoleData) {
+    if (this.#consoleDataOptions?.include) {
+      let messages = context.getConsoleData();
+
+      if (this.#consoleDataOptions.types?.length) {
+        const normalizedTypes = new Set(this.#consoleDataOptions.types);
+        messages = messages.filter(message => {
+          if (!('type' in message)) {
+            return normalizedTypes.has('error');
+          }
+          const type = message.type();
+          return normalizedTypes.has(type);
+        });
+      }
+
       response.push('## Console messages');
-      if (this.#formattedConsoleData.length) {
-        response.push(...this.#formattedConsoleData);
+      if (messages.length) {
+        const data = this.#dataWithPagination(
+          messages,
+          this.#consoleDataOptions.pagination,
+        );
+        response.push(...data.info);
+        response.push(
+          ...(await Promise.all(
+            data.items.map(message => formatConsoleEvent(message)),
+          )),
+        );
       } else {
         response.push('<no console messages found>');
       }
diff --git a/src/formatters/consoleFormatter.ts b/src/formatters/consoleFormatter.ts
@@ -4,11 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import type {
-  ConsoleMessage,
-  JSHandle,
-  ConsoleMessageLocation,
-} from 'puppeteer-core';
+import type {ConsoleMessage, JSHandle} from 'puppeteer-core';
 
 const logLevels: Record<string, string> = {
   log: 'Log',
@@ -31,66 +27,37 @@ export async function formatConsoleEvent(
 
 async function formatConsoleMessage(msg: ConsoleMessage): Promise<string> {
   const logLevel = logLevels[msg.type()];
+  const text = msg.text();
   const args = msg.args();
 
-  if (logLevel === 'Error') {
-    let message = `${logLevel}> `;
-    if (msg.text() === 'JSHandle@error') {
-      const errorHandle = args[0] as JSHandle<Error>;
-      message += await errorHandle
-        .evaluate(error => {
-          return error.toString();
-        })
-        .catch(() => {
-          return 'Error occurred';
-        });
-      void errorHandle.dispose().catch();
+  const formattedArgs = await formatArgs(args, text);
+  return `${logLevel}> ${text} ${formattedArgs}`.trim();
+}
 
-      const formattedArgs = await formatArgs(args.slice(1));
-      if (formattedArgs) {
-        message += ` ${formattedArgs}`;
-      }
-    } else {
-      message += msg.text();
-      const formattedArgs = await formatArgs(args);
-      if (formattedArgs) {
-        message += ` ${formattedArgs}`;
-      }
-      for (const frame of msg.stackTrace()) {
-        message += '\n' + formatStackFrame(frame);
-      }
-    }
-    return message;
+// Only includes the first arg and indicates that there are more args
+async function formatArgs(
+  args: readonly JSHandle[],
+  messageText: string,
+): Promise<string> {
+  if (args.length === 0) {
+    return '';
   }
 
-  const formattedArgs = await formatArgs(args);
-  const text = msg.text();
-
-  return `${logLevel}> ${formatStackFrame(
-    msg.location(),
-  )}: ${text} ${formattedArgs}`.trim();
-}
-
-async function formatArgs(args: readonly JSHandle[]): Promise<string> {
-  const argValues = await Promise.all(
-    args.map(arg =>
-      arg.jsonValue().catch(() => {
-        // Ignore errors
-      }),
-    ),
-  );
+  let formattedArgs = '';
+  const firstArg = await args[0].jsonValue().catch(() => {
+    // Ignore errors
+  });
 
-  return argValues
-    .map(value => {
-      return typeof value === 'object' ? JSON.stringify(value) : String(value);
-    })
-    .join(' ');
-}
+  if (firstArg !== messageText) {
+    formattedArgs +=
+      typeof firstArg === 'object'
+        ? JSON.stringify(firstArg)
+        : String(firstArg);
+  }
 
-function formatStackFrame(stackFrame: ConsoleMessageLocation): string {
-  if (!stackFrame?.url) {
-    return '<unknown>';
+  if (args.length > 1) {
+    return `${formattedArgs} ...`;
   }
-  const filename = stackFrame.url.replace(/^.*\//, '');
-  return `${filename}:${stackFrame.lineNumber}:${stackFrame.columnNumber}`;
+
+  return formattedArgs;
 }
diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.ts
@@ -47,7 +47,10 @@ export interface Response {
     value: boolean,
     options?: {pageSize?: number; pageIdx?: number; resourceTypes?: string[]},
   ): void;
-  setIncludeConsoleData(value: boolean): void;
+  setIncludeConsoleData(
+    value: boolean,
+    options?: {pageSize?: number; pageIdx?: number; types?: string[]},
+  ): void;
   setIncludeSnapshot(value: boolean): void;
   attachImage(value: ImageContentData): void;
   attachNetworkRequest(reqid: number): void;
diff --git a/src/tools/console.ts b/src/tools/console.ts
@@ -4,19 +4,74 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import type {ConsoleMessageType} from 'puppeteer-core';
+import z from 'zod';
+
 import {ToolCategories} from './categories.js';
 import {defineTool} from './ToolDefinition.js';
 
+const FILTERABLE_MESSAGE_TYPES: readonly [
+  ConsoleMessageType,
+  ...ConsoleMessageType[],
+] = [
+  'log',
+  'debug',
+  'info',
+  'error',
+  'warn',
+  'dir',
+  'dirxml',
+  'table',
+  'trace',
+  'clear',
+  'startGroup',
+  'startGroupCollapsed',
+  'endGroup',
+  'assert',
+  'profile',
+  'profileEnd',
+  'count',
+  'timeEnd',
+  'verbose',
+];
+
 export const consoleTool = defineTool({
   name: 'list_console_messages',
   description:
     'List all console messages for the currently selected page since the last navigation.',
   annotations: {
-    category: ToolCategories.DEBUGGING,
+    category: ToolCategories.NETWORK,
     readOnlyHint: true,
   },
-  schema: {},
-  handler: async (_request, response) => {
-    response.setIncludeConsoleData(true);
+  schema: {
+    pageSize: z
+      .number()
+      .int()
+      .positive()
+      .optional()
+      .describe(
+        'Maximum number of messages to return. When omitted, returns all requests.',
+      ),
+    pageIdx: z
+      .number()
+      .int()
+      .min(0)
+      .optional()
+      .describe(
+        'Page number to return (0-based). When omitted, returns the first page.',
+      ),
+    types: z
+      .array(z.enum(FILTERABLE_MESSAGE_TYPES))
+      .optional()
+      .describe(
+        'Filter messages to only return messages of the specified resource types. When omitted or empty, returns all messages.',
+      ),
+  },
+  handler: async (request, response) => {
+    response.setIncludeConsoleData(true, {
+      pageSize: request.params.pageSize,
+      pageIdx: request.params.pageIdx,
+      types: request.params.types,
+    });
   },
 });
diff --git a/tests/McpResponse.test.ts b/tests/McpResponse.test.ts
@@ -319,8 +319,7 @@ reqid=1 GET http://example.com [pending]`,
       // Cannot check the full text because it contains local file path
       assert.ok(
         result[0].text.toString().startsWith(`# test response
-## Console messages
-Log>`),
+## Console messages`),
       );
       assert.ok(result[0].text.toString().includes('Hello from the test'));
     });
diff --git a/tests/formatters/consoleFormatter.test.ts b/tests/formatters/consoleFormatter.test.ts
diff --git a/tests/tools/console.test.ts b/tests/tools/console.test.ts
