chore: rename options to includePreserved<Data> (#455)

Author: Lightning00Blade

docs/tool-reference.md

@@ -269,7 +269,7 @@
 
 **Parameters:**
 
-- **includePreviousNavigations** (boolean) _(optional)_: Whether to include requests from previous navigations.
+- **includePreservedRequests** (boolean) _(optional)_: Set to true to return the preserved requests over the last 3 navigations.
 - **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.
 - **resourceTypes** (array) _(optional)_: Filter requests to only return requests of the specified resource types. When omitted or empty, returns all requests.
@@ -314,7 +314,7 @@ so returned values have to JSON-serializable.
 
 **Parameters:**
 
-- **includePreviousNavigations** (boolean) _(optional)_: Whether to include messages from previous navigations.
+- **includePreservedMessages** (boolean) _(optional)_: Set to true to return the preserved messages over the last 3 navigations.
 - **pageIdx** (integer) _(optional)_: Page number to return (0-based). When omitted, returns the first page.
 - **pageSize** (integer) _(optional)_: Maximum number of messages to return. When omitted, returns all requests.
 - **types** (array) _(optional)_: Filter messages to only return messages of the specified resource types. When omitted or empty, returns all messages.

src/McpContext.ts

@@ -140,16 +140,16 @@ export class McpContext implements Context {
     return context;
   }
 
-  getNetworkRequests(includePreviousNavigations?: boolean): HTTPRequest[] {
+  getNetworkRequests(includePreservedRequests?: boolean): HTTPRequest[] {
     const page = this.getSelectedPage();
-    return this.#networkCollector.getData(page, includePreviousNavigations);
+    return this.#networkCollector.getData(page, includePreservedRequests);
   }
 
   getConsoleData(
-    includePreviousNavigations?: boolean,
+    includePreservedMessages?: boolean,
   ): Array<ConsoleMessage | Error> {
     const page = this.getSelectedPage();
-    return this.#consoleCollector.getData(page, includePreviousNavigations);
+    return this.#consoleCollector.getData(page, includePreservedMessages);
   }
 
   getConsoleMessageStableId(message: ConsoleMessage | Error): number {

src/McpResponse.ts

@@ -40,13 +40,13 @@ export class McpResponse implements Response {
     include: boolean;
     pagination?: PaginationOptions;
     resourceTypes?: ResourceType[];
-    includePreviousNavigations?: boolean;
+    includePreservedRequests?: boolean;
   };
   #consoleDataOptions?: {
     include: boolean;
     pagination?: PaginationOptions;
     types?: string[];
-    includePreviousNavigations?: boolean;
+    includePreservedMessages?: boolean;
   };
 
   setIncludePages(value: boolean): void {
@@ -62,7 +62,7 @@ export class McpResponse implements Response {
     value: boolean,
     options?: PaginationOptions & {
       resourceTypes?: ResourceType[];
-      includePreviousNavigations?: boolean;
+      includePreservedRequests?: boolean;
     },
   ): void {
     if (!value) {
@@ -80,15 +80,15 @@ export class McpResponse implements Response {
             }
           : undefined,
       resourceTypes: options?.resourceTypes,
-      includePreviousNavigations: options?.includePreviousNavigations,
+      includePreservedRequests: options?.includePreservedRequests,
     };
   }
 
   setIncludeConsoleData(
     value: boolean,
     options?: PaginationOptions & {
       types?: string[];
-      includePreviousNavigations?: boolean;
+      includePreservedMessages?: boolean;
     },
   ): void {
     if (!value) {
@@ -106,7 +106,7 @@ export class McpResponse implements Response {
             }
           : undefined,
       types: options?.types,
-      includePreviousNavigations: options?.includePreviousNavigations,
+      includePreservedMessages: options?.includePreservedMessages,
     };
   }
 
@@ -232,7 +232,7 @@ export class McpResponse implements Response {
     let consoleListData: ConsoleMessageData[] | undefined;
     if (this.#consoleDataOptions?.include) {
       let messages = context.getConsoleData(
-        this.#consoleDataOptions.includePreviousNavigations,
+        this.#consoleDataOptions.includePreservedMessages,
       );
 
       if (this.#consoleDataOptions.types?.length) {
@@ -353,7 +353,7 @@ Call ${handleDialog.name} to handle it before continuing.`);
 
     if (this.#networkRequestsOptions?.include) {
       let requests = context.getNetworkRequests(
-        this.#networkRequestsOptions?.includePreviousNavigations,
+        this.#networkRequestsOptions?.includePreservedRequests,
       );
 
       // Apply resource type filtering if specified

src/PageCollector.ts

@@ -133,13 +133,13 @@ export class PageCollector<T> {
     this.storage.delete(page);
   }
 
-  getData(page: Page, includePreviousNavigations?: boolean): T[] {
+  getData(page: Page, includePreservedData?: boolean): T[] {
     const navigations = this.storage.get(page);
     if (!navigations) {
       return [];
     }
 
-    if (!includePreviousNavigations) {
+    if (!includePreservedData) {
       return navigations[0];
     }
 

src/tools/ToolDefinition.ts

@@ -49,14 +49,14 @@ export interface Response {
     value: boolean,
     options?: PaginationOptions & {
       resourceTypes?: string[];
-      includePreviousNavigations?: boolean;
+      includePreservedRequests?: boolean;
     },
   ): void;
   setIncludeConsoleData(
     value: boolean,
     options?: PaginationOptions & {
       types?: string[];
-      includePreviousNavigations?: boolean;
+      includePreservedMessages?: boolean;
     },
   ): void;
   setIncludeSnapshot(value: boolean): void;

src/tools/console.ts

@@ -66,18 +66,20 @@ export const listConsoleMessages = defineTool({
       .describe(
         'Filter messages to only return messages of the specified resource types. When omitted or empty, returns all messages.',
       ),
-    includePreviousNavigations: zod
+    includePreservedMessages: zod
       .boolean()
       .default(false)
       .optional()
-      .describe('Whether to include messages from previous navigations.'),
+      .describe(
+        'Set to true to return the preserved messages over the last 3 navigations.',
+      ),
   },
   handler: async (request, response) => {
     response.setIncludeConsoleData(true, {
       pageSize: request.params.pageSize,
       pageIdx: request.params.pageIdx,
       types: request.params.types,
-      includePreviousNavigations: request.params.includePreviousNavigations,
+      includePreservedMessages: request.params.includePreservedMessages,
     });
   },
 });

src/tools/network.ts

@@ -62,18 +62,20 @@ export const listNetworkRequests = defineTool({
       .describe(
         'Filter requests to only return requests of the specified resource types. When omitted or empty, returns all requests.',
       ),
-    includePreviousNavigations: zod
+    includePreservedRequests: zod
       .boolean()
       .default(false)
       .optional()
-      .describe('Whether to include requests from previous navigations.'),
+      .describe(
+        'Set to true to return the preserved requests over the last 3 navigations.',
+      ),
   },
   handler: async (request, response) => {
     response.setIncludeNetworkRequests(true, {
       pageSize: request.params.pageSize,
       pageIdx: request.params.pageIdx,
       resourceTypes: request.params.resourceTypes,
-      includePreviousNavigations: request.params.includePreviousNavigations,
+      includePreservedRequests: request.params.includePreservedRequests,
     });
   },
 });

tests/tools/network.test.ts

@@ -61,7 +61,7 @@ describe('network', () => {
         await listNetworkRequests.handler(
           {
             params: {
-              includePreviousNavigations: true,
+              includePreservedRequests: true,
             },
           },
           response,
@@ -99,7 +99,7 @@ describe('network', () => {
         await listNetworkRequests.handler(
           {
             params: {
-              includePreviousNavigations: true,
+              includePreservedRequests: true,
             },
           },
           response,