docs: generate docs

Author: OzTamir

docs/tool-reference.md

@@ -262,7 +262,10 @@
 
 **Description:** List all requests for the currently selected page
 
-**Parameters:** None
+**Parameters:**
+
+- **pageSize** (integer) _(optional)_: Maximum number of requests to return. When omitted, returns all requests.
+- **pageToken** (string) _(optional)_: Opaque token representing the next page. Use the token returned by a previous call.
 
 ---
 

src/McpResponse.ts

@@ -3,16 +3,16 @@
  * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { ImageContentData, Response } from './tools/ToolDefinition.js';
-import type { McpContext } from './McpContext.js';
-import { ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';
+import type {ImageContentData, Response} from './tools/ToolDefinition.js';
+import type {McpContext} from './McpContext.js';
+import {ImageContent, TextContent} from '@modelcontextprotocol/sdk/types.js';
 import {
   getFormattedHeaderValue,
   getShortDescriptionForRequest,
   getStatusFromRequest,
 } from './formatters/networkFormatter.js';
-import { formatA11ySnapshot } from './formatters/snapshotFormatter.js';
-import { formatConsoleEvent } from './formatters/consoleFormatter.js';
+import {formatA11ySnapshot} from './formatters/snapshotFormatter.js';
+import {formatConsoleEvent} from './formatters/consoleFormatter.js';
 import {
   paginateNetworkRequests,
   type NetworkPaginationOptions,
@@ -39,7 +39,7 @@ export class McpResponse implements Response {
 
   setIncludeNetworkRequests(
     value: boolean,
-    options?: { pageSize?: number; pageToken?: string | null },
+    options?: {pageSize?: number; pageToken?: string | null},
   ): void {
     this.#includeNetworkRequests = value;
     if (!value) {
@@ -201,7 +201,7 @@ Call browser_handle_dialog to handle it before continuing.`);
         if (paginationResult.invalidToken) {
           response.push('Invalid page token provided. Showing first page.');
         }
-        const { startIndex, endIndex } = paginationResult;
+        const {startIndex, endIndex} = paginationResult;
         response.push(
           `Showing ${startIndex + 1}-${endIndex} of ${requests.length}.`,
         );

src/tools/ToolDefinition.ts

@@ -5,9 +5,9 @@
  */
 
 import z from 'zod';
-import { Dialog, ElementHandle, Page } from 'puppeteer-core';
-import { ToolCategories } from './categories.js';
-import { TraceResult } from '../trace-processing/parse.js';
+import {Dialog, ElementHandle, Page} from 'puppeteer-core';
+import {ToolCategories} from './categories.js';
+import {TraceResult} from '../trace-processing/parse.js';
 
 export interface ToolDefinition<
   Schema extends Zod.ZodRawShape = Zod.ZodRawShape,
@@ -44,7 +44,7 @@ export interface Response {
   setIncludePages(value: boolean): void;
   setIncludeNetworkRequests(
     value: boolean,
-    options?: { pageSize?: number; pageToken?: string | null },
+    options?: {pageSize?: number; pageToken?: string | null},
   ): void;
   setIncludeConsoleData(value: boolean): void;
   setIncludeSnapshot(value: boolean): void;
@@ -72,7 +72,7 @@ export type Context = Readonly<{
   saveTemporaryFile(
     data: Uint8Array<ArrayBufferLike>,
     mimeType: 'image/png' | 'image/jpeg',
-  ): Promise<{ filename: string }>;
+  ): Promise<{filename: string}>;
   waitForEventsAfterAction(action: () => Promise<unknown>): Promise<void>;
 }>;
 

src/tools/network.ts

@@ -5,8 +5,8 @@
  */
 
 import z from 'zod';
-import { defineTool } from './ToolDefinition.js';
-import { ToolCategories } from './categories.js';
+import {defineTool} from './ToolDefinition.js';
+import {ToolCategories} from './categories.js';
 
 export const listNetworkRequests = defineTool({
   name: 'list_network_requests',

src/utils/networkPagination.ts

@@ -3,90 +3,96 @@
  * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { type HTTPRequest } from 'puppeteer-core';
+import {type HTTPRequest} from 'puppeteer-core';
 
 export type NetworkPaginationOptions = {
-    pageSize?: number;
-    pageToken?: string;
+  pageSize?: number;
+  pageToken?: string;
 };
 
 export type NetworkPaginationResult = {
-    requests: readonly HTTPRequest[];
-    nextPageToken?: string;
-    previousPageToken?: string;
-    startIndex: number;
-    endIndex: number;
-    invalidToken: boolean;
+  requests: readonly HTTPRequest[];
+  nextPageToken?: string;
+  previousPageToken?: string;
+  startIndex: number;
+  endIndex: number;
+  invalidToken: boolean;
 };
 
 const DEFAULT_PAGE_SIZE = 20;
 
 export function paginateNetworkRequests(
-    requests: readonly HTTPRequest[],
-    options?: NetworkPaginationOptions,
+  requests: readonly HTTPRequest[],
+  options?: NetworkPaginationOptions,
 ): NetworkPaginationResult {
-    const total = requests.length;
+  const total = requests.length;
 
-    if (!options || noPaginationOptions(options)) {
-        return {
-            requests,
-            nextPageToken: undefined,
-            previousPageToken: undefined,
-            startIndex: 0,
-            endIndex: total,
-            invalidToken: false,
-        };
-    }
+  if (!options || noPaginationOptions(options)) {
+    return {
+      requests,
+      nextPageToken: undefined,
+      previousPageToken: undefined,
+      startIndex: 0,
+      endIndex: total,
+      invalidToken: false,
+    };
+  }
 
-    const pageSize = validatePageSize(options.pageSize, total);
-    const { startIndex, invalidToken } = resolveStartIndex(options.pageToken, total);
+  const pageSize = validatePageSize(options.pageSize, total);
+  const {startIndex, invalidToken} = resolveStartIndex(
+    options.pageToken,
+    total,
+  );
 
-    const pageRequests = requests.slice(startIndex, startIndex + pageSize);
-    const endIndex = startIndex + pageRequests.length;
+  const pageRequests = requests.slice(startIndex, startIndex + pageSize);
+  const endIndex = startIndex + pageRequests.length;
 
-    const nextPageToken = endIndex < total ? String(endIndex) : undefined;
-    const previousPageToken =
-        startIndex > 0 ? String(Math.max(startIndex - pageSize, 0)) : undefined;
+  const nextPageToken = endIndex < total ? String(endIndex) : undefined;
+  const previousPageToken =
+    startIndex > 0 ? String(Math.max(startIndex - pageSize, 0)) : undefined;
 
-    return {
-        requests: pageRequests,
-        nextPageToken,
-        previousPageToken,
-        startIndex,
-        endIndex,
-        invalidToken,
-    };
+  return {
+    requests: pageRequests,
+    nextPageToken,
+    previousPageToken,
+    startIndex,
+    endIndex,
+    invalidToken,
+  };
 }
 
 function noPaginationOptions(options: NetworkPaginationOptions): boolean {
-    return (
-        options.pageSize === undefined &&
-        (options.pageToken === undefined || options.pageToken === null)
-    );
+  return (
+    options.pageSize === undefined &&
+    (options.pageToken === undefined || options.pageToken === null)
+  );
 }
 
 function validatePageSize(pageSize: number | undefined, total: number): number {
-    if (pageSize === undefined) {
-        return total || DEFAULT_PAGE_SIZE;
-    }
-    if (!Number.isInteger(pageSize) || pageSize <= 0) {
-        return DEFAULT_PAGE_SIZE;
-    }
-    return Math.min(pageSize, Math.max(total, 1));
+  if (pageSize === undefined) {
+    return total || DEFAULT_PAGE_SIZE;
+  }
+  if (!Number.isInteger(pageSize) || pageSize <= 0) {
+    return DEFAULT_PAGE_SIZE;
+  }
+  return Math.min(pageSize, Math.max(total, 1));
 }
 
-function resolveStartIndex(pageToken: string | undefined, total: number): {
-    startIndex: number;
-    invalidToken: boolean;
+function resolveStartIndex(
+  pageToken: string | undefined,
+  total: number,
+): {
+  startIndex: number;
+  invalidToken: boolean;
 } {
-    if (pageToken === undefined || pageToken === null) {
-        return { startIndex: 0, invalidToken: false };
-    }
+  if (pageToken === undefined || pageToken === null) {
+    return {startIndex: 0, invalidToken: false};
+  }
 
-    const parsed = Number.parseInt(pageToken, 10);
-    if (Number.isNaN(parsed) || parsed < 0 || parsed >= total) {
-        return { startIndex: 0, invalidToken: true };
-    }
+  const parsed = Number.parseInt(pageToken, 10);
+  if (Number.isNaN(parsed) || parsed < 0 || parsed >= total) {
+    return {startIndex: 0, invalidToken: true};
+  }
 
-    return { startIndex: parsed, invalidToken: false };
+  return {startIndex: parsed, invalidToken: false};
 }

tests/McpResponse.test.ts

@@ -3,10 +3,10 @@
  * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { describe, it } from 'node:test';
+import {describe, it} from 'node:test';
 import assert from 'assert';
 
-import { getMockRequest, html, withBrowser } from './utils.js';
+import {getMockRequest, html, withBrowser} from './utils.js';
 
 describe('McpResponse', () => {
   it('list pages', async () => {
@@ -120,7 +120,7 @@ Navigation timeout set to 100000 ms`,
   });
   it('adds image when image is attached', async () => {
     await withBrowser(async (response, context) => {
-      response.attachImage({ data: 'imageBase64', mimeType: 'image/png' });
+      response.attachImage({data: 'imageBase64', mimeType: 'image/png'});
       const result = await response.handle('test', context);
       assert.strictEqual(result[0].text, `# test response`);
       assert.equal(result[1].type, 'image');
@@ -182,9 +182,7 @@ Call browser_handle_dialog to handle it before continuing.`,
       };
       const result = await response.handle('test', context);
       const text = result[0].text as string;
-      assert.ok(
-        text.includes(`## Network requests`),
-      );
+      assert.ok(text.includes(`## Network requests`));
       assert.ok(text.includes('http://example.com GET [pending]'));
     });
   });
@@ -265,7 +263,7 @@ Log>`),
 describe('McpResponse network pagination', () => {
   it('returns all requests when pagination is not provided', async () => {
     await withBrowser(async (response, context) => {
-      const requests = Array.from({ length: 5 }, () => getMockRequest());
+      const requests = Array.from({length: 5}, () => getMockRequest());
       context.getNetworkRequests = () => requests;
       response.setIncludeNetworkRequests(true);
       const result = await response.handle('test', context);
@@ -278,13 +276,13 @@ describe('McpResponse network pagination', () => {
 
   it('returns first page by default', async () => {
     await withBrowser(async (response, context) => {
-      const requests = Array.from({ length: 30 }, (_, idx) =>
-        getMockRequest({ method: `GET-${idx}` }),
+      const requests = Array.from({length: 30}, (_, idx) =>
+        getMockRequest({method: `GET-${idx}`}),
       );
       context.getNetworkRequests = () => {
         return requests;
       };
-      response.setIncludeNetworkRequests(true, { pageSize: 10 });
+      response.setIncludeNetworkRequests(true, {pageSize: 10});
       const result = await response.handle('test', context);
       const text = (result[0].text as string).toString();
       assert.ok(text.includes('Showing 1-10 of 30.'));
@@ -295,8 +293,8 @@ describe('McpResponse network pagination', () => {
 
   it('returns subsequent page when token provided', async () => {
     await withBrowser(async (response, context) => {
-      const requests = Array.from({ length: 25 }, (_, idx) =>
-        getMockRequest({ method: `GET-${idx}` }),
+      const requests = Array.from({length: 25}, (_, idx) =>
+        getMockRequest({method: `GET-${idx}`}),
       );
       context.getNetworkRequests = () => requests;
       response.setIncludeNetworkRequests(true, {
@@ -313,7 +311,7 @@ describe('McpResponse network pagination', () => {
 
   it('handles invalid token by showing first page', async () => {
     await withBrowser(async (response, context) => {
-      const requests = Array.from({ length: 5 }, () => getMockRequest());
+      const requests = Array.from({length: 5}, () => getMockRequest());
       context.getNetworkRequests = () => requests;
       response.setIncludeNetworkRequests(true, {
         pageSize: 2,

tests/tools/network.test.ts

@@ -3,10 +3,10 @@
  * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { describe, it } from 'node:test';
+import {describe, it} from 'node:test';
 import assert from 'assert';
 
-import { withBrowser } from '../utils.js';
+import {withBrowser} from '../utils.js';
 import {
   getNetworkRequest,
   listNetworkRequests,
@@ -16,7 +16,7 @@ describe('network', () => {
   describe('network_list_requests', () => {
     it('list requests', async () => {
       await withBrowser(async (response, context) => {
-        await listNetworkRequests.handler({ params: {} }, response, context);
+        await listNetworkRequests.handler({params: {}}, response, context);
         assert.ok(response.includeNetworkRequests);
         assert.strictEqual(response.networkRequestsPageToken, undefined);
       });
@@ -28,7 +28,7 @@ describe('network', () => {
         const page = await context.getSelectedPage();
         await page.goto('data:text/html,<div>Hello MCP</div>');
         await getNetworkRequest.handler(
-          { params: { url: 'data:text/html,<div>Hello MCP</div>' } },
+          {params: {url: 'data:text/html,<div>Hello MCP</div>'}},
           response,
           context,
         );