docs: auto generated docs + formatting

Author: OzTamir

docs/tool-reference.md

@@ -266,7 +266,7 @@
 
 - **pageIdx** (integer) _(optional)_: Page number to return (0-based). When omitted, returns the first page.
 - **pageSize** (integer) _(optional)_: Maximum number of requests to return. When omitted, returns all requests.
-- **resourceType** (array) _(optional)_: Filter requests to only return requests of the specified resource types. When omitted, returns all requests.
+- **resourceTypes** (array) _(optional)_: Filter requests to only return requests of the specified resource types. When omitted or empty, returns all requests.
 
 ---
 

src/McpResponse.ts

@@ -7,18 +7,18 @@ import type {
   ImageContent,
   TextContent,
 } from '@modelcontextprotocol/sdk/types.js';
-import type { ResourceType } from 'puppeteer-core';
+import type {ResourceType} from 'puppeteer-core';
 
-import { formatConsoleEvent } from './formatters/consoleFormatter.js';
+import {formatConsoleEvent} from './formatters/consoleFormatter.js';
 import {
   getFormattedHeaderValue,
   getShortDescriptionForRequest,
   getStatusFromRequest,
 } from './formatters/networkFormatter.js';
-import { formatA11ySnapshot } from './formatters/snapshotFormatter.js';
-import type { McpContext } from './McpContext.js';
-import type { ImageContentData, Response } from './tools/ToolDefinition.js';
-import { paginate, type PaginationOptions } from './utils/pagination.js';
+import {formatA11ySnapshot} from './formatters/snapshotFormatter.js';
+import type {McpContext} from './McpContext.js';
+import type {ImageContentData, Response} from './tools/ToolDefinition.js';
+import {paginate, type PaginationOptions} from './utils/pagination.js';
 
 export class McpResponse implements Response {
   #includePages = false;
@@ -60,9 +60,9 @@ export class McpResponse implements Response {
       pagination:
         options?.pageSize || options?.pageIdx
           ? {
-            pageSize: options.pageSize,
-            pageIdx: options.pageIdx,
-          }
+              pageSize: options.pageSize,
+              pageIdx: options.pageIdx,
+            }
           : undefined,
       resourceTypes: options?.resourceTypes,
     };
@@ -217,7 +217,7 @@ Call browser_handle_dialog to handle it before continuing.`);
           response.push('Invalid page number provided. Showing first page.');
         }
 
-        const { startIndex, endIndex, currentPage, totalPages } =
+        const {startIndex, endIndex, currentPage, totalPages} =
           paginationResult;
         response.push(
           `Showing ${startIndex + 1}-${endIndex} of ${requests.length} (Page ${currentPage + 1} of ${totalPages}).`,

src/tools/network.ts

@@ -4,36 +4,33 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import type { ResourceType } from 'puppeteer-core';
+import type {ResourceType} from 'puppeteer-core';
 import z from 'zod';
 
-import { ToolCategories } from './categories.js';
-import { defineTool } from './ToolDefinition.js';
+import {ToolCategories} from './categories.js';
+import {defineTool} from './ToolDefinition.js';
 
-const FILTERABLE_RESOURCE_TYPES: readonly [
-  ResourceType,
-  ...ResourceType[],
-] = [
-    'document',
-    'stylesheet',
-    'image',
-    'media',
-    'font',
-    'script',
-    'texttrack',
-    'xhr',
-    'fetch',
-    'prefetch',
-    'eventsource',
-    'websocket',
-    'manifest',
-    'signedexchange',
-    'ping',
-    'cspviolationreport',
-    'preflight',
-    'fedcm',
-    'other',
-  ];
+const FILTERABLE_RESOURCE_TYPES: readonly [ResourceType, ...ResourceType[]] = [
+  'document',
+  'stylesheet',
+  'image',
+  'media',
+  'font',
+  'script',
+  'texttrack',
+  'xhr',
+  'fetch',
+  'prefetch',
+  'eventsource',
+  'websocket',
+  'manifest',
+  'signedexchange',
+  'ping',
+  'cspviolationreport',
+  'preflight',
+  'fedcm',
+  'other',
+];
 
 export const listNetworkRequests = defineTool({
   name: 'list_network_requests',
@@ -60,9 +57,7 @@ export const listNetworkRequests = defineTool({
         'Page number to return (0-based). When omitted, returns the first page.',
       ),
     resourceTypes: z
-      .array(
-        z.enum(FILTERABLE_RESOURCE_TYPES),
-      )
+      .array(z.enum(FILTERABLE_RESOURCE_TYPES))
       .optional()
       .describe(
         'Filter requests to only return requests of the specified resource types. When omitted or empty, returns all requests.',

tests/McpResponse.test.ts

@@ -4,9 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import assert from 'node:assert';
-import { describe, it } from 'node:test';
+import {describe, it} from 'node:test';
 
-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');
@@ -273,10 +273,10 @@ describe('McpResponse network request filtering', () => {
       });
       context.getNetworkRequests = () => {
         return [
-          getMockRequest({ resourceType: 'script' }),
-          getMockRequest({ resourceType: 'image' }),
-          getMockRequest({ resourceType: 'stylesheet' }),
-          getMockRequest({ resourceType: 'document' }),
+          getMockRequest({resourceType: 'script'}),
+          getMockRequest({resourceType: 'image'}),
+          getMockRequest({resourceType: 'stylesheet'}),
+          getMockRequest({resourceType: 'document'}),
         ];
       };
       const result = await response.handle('test', context);
@@ -298,9 +298,9 @@ http://example.com GET [pending]`,
       });
       context.getNetworkRequests = () => {
         return [
-          getMockRequest({ resourceType: 'script' }),
-          getMockRequest({ resourceType: 'image' }),
-          getMockRequest({ resourceType: 'stylesheet' }),
+          getMockRequest({resourceType: 'script'}),
+          getMockRequest({resourceType: 'image'}),
+          getMockRequest({resourceType: 'stylesheet'}),
         ];
       };
       const result = await response.handle('test', context);
@@ -321,9 +321,9 @@ http://example.com GET [pending]`,
       });
       context.getNetworkRequests = () => {
         return [
-          getMockRequest({ resourceType: 'script' }),
-          getMockRequest({ resourceType: 'image' }),
-          getMockRequest({ resourceType: 'stylesheet' }),
+          getMockRequest({resourceType: 'script'}),
+          getMockRequest({resourceType: 'image'}),
+          getMockRequest({resourceType: 'stylesheet'}),
         ];
       };
       const result = await response.handle('test', context);
@@ -341,11 +341,11 @@ No requests found.`,
       response.setIncludeNetworkRequests(true);
       context.getNetworkRequests = () => {
         return [
-          getMockRequest({ resourceType: 'script' }),
-          getMockRequest({ resourceType: 'image' }),
-          getMockRequest({ resourceType: 'stylesheet' }),
-          getMockRequest({ resourceType: 'document' }),
-          getMockRequest({ resourceType: 'font' }),
+          getMockRequest({resourceType: 'script'}),
+          getMockRequest({resourceType: 'image'}),
+          getMockRequest({resourceType: 'stylesheet'}),
+          getMockRequest({resourceType: 'document'}),
+          getMockRequest({resourceType: 'font'}),
         ];
       };
       const result = await response.handle('test', context);
@@ -370,11 +370,11 @@ http://example.com GET [pending]`,
       });
       context.getNetworkRequests = () => {
         return [
-          getMockRequest({ resourceType: 'script' }),
-          getMockRequest({ resourceType: 'image' }),
-          getMockRequest({ resourceType: 'stylesheet' }),
-          getMockRequest({ resourceType: 'document' }),
-          getMockRequest({ resourceType: 'font' }),
+          getMockRequest({resourceType: 'script'}),
+          getMockRequest({resourceType: 'image'}),
+          getMockRequest({resourceType: 'stylesheet'}),
+          getMockRequest({resourceType: 'document'}),
+          getMockRequest({resourceType: 'font'}),
         ];
       };
       const result = await response.handle('test', context);
@@ -396,7 +396,7 @@ http://example.com GET [pending]`,
 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);
@@ -409,13 +409,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 (Page 1 of 3).'));
@@ -426,8 +426,8 @@ describe('McpResponse network pagination', () => {
 
   it('returns subsequent page when pageIdx 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, {
@@ -444,7 +444,7 @@ describe('McpResponse network pagination', () => {
 
   it('handles invalid page number 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,