@diegosouzacdv/jev-browser-mcp 0.6.2 → 0.7.1

package/mcp_servers/jev-browser-npm/src/server.mjs

@@ -7,33 +7,74 @@ import { serveStdio } from "@modelcontextprotocol/server/stdio";
 import { chromium } from "playwright";
 import * as z from "zod/v4";
 import packageManifest from "../../../package.json" with { type: "json" };
-import { loadSettings, JevBrowserError } from "./config.mjs";
-import { chooseNextAction, createMutationAuthorizationStore, executeBrowserFlow } from "./flow.mjs";
-
-const browserPools = new Set();
+import { loadSettings, JevBrowserError } from "./config.mjs";
+import { chooseNextAction, collectFlowContractIssues, createMutationAuthorizationStore, describeBrowserActions, executeBrowserFlow } from "./flow.mjs";
+
+const browserContract = describeBrowserActions();
+const jsonObject = z.record(z.string(), z.unknown());
+const browserOptionsShape = Object.fromEntries(browserContract.options.map((key) => {
+  const value = key === "return_snapshot" ? z.enum(["diff", "full", "none"])
+    : key === "capture_network" ? z.enum(["none", "errors", "all"])
+    : key === "reuse_page_match" ? z.enum(["url", "path"])
+      : key === "color_scheme" ? z.enum(["light", "dark", "no-preference"])
+        : key === "permissions" ? z.array(z.enum(["microphone", "geolocation"]))
+          : key === "console_levels" ? z.array(z.enum(["log", "info", "debug", "warn", "error"]))
+            : key === "ready" ? z.union([z.string(), z.record(z.string(), z.unknown()), z.array(z.union([z.string(), z.record(z.string(), z.unknown())]))])
+              : ["allow_mutations", "block_trackers", "capture_console_errors", "capture_network_error_bodies", "capture_network_errors", "auto_angular_idle", "block_fonts", "continue_from_current_page", "dry_run", "fast_path", "local_only", "ready_network_idle", "reuse_page", "screenshot_on_failure", "screenshot_on_success", "record_video", "mobile", "snapshot_include_hidden", "include_unnamed_controls", "stop_on_expected", "trace_on_failure", "trace_on_success", "fresh_context", "clear_storage"].includes(key) ? z.boolean()
+                : ["max_flow_steps", "ready_stable_ms", "ready_timeout_seconds", "step_timeout_seconds"].includes(key) ? z.number().positive()
+                  : ["busy_selectors", "login_text", "login_url_contains"].includes(key) ? z.array(z.string())
+                    : ["viewport", "geolocation", "wait_for_http", "fake_media"].includes(key) ? z.union([z.string(), jsonObject])
+                      : z.string();
+  return [key, value.optional()];
+}));
+const browserOptionsSchema = z.object(browserOptionsShape).passthrough();
+const candidatePlanSchema = z.object({
+  description: z.string().optional(),
+  steps: z.array(z.record(z.string(), z.unknown())).optional(),
+  comment: z.string().optional(),
+  when: z.unknown().optional(),
+}).strict();
+const expectedOutcomeSchema = z.union([
+  z.string(),
+  z.object({
+    text: z.string().optional(),
+    request: z.string().optional(),
+    method: z.string().optional(),
+    status: z.number().int().min(100).max(599).optional(),
+    message_contains: z.string().optional(),
+  }).strict().refine((value) => Boolean(value.text || value.request), "expected_outcome needs text or request"),
+]);
+
+const browserPools = new Set();
 
 class BrowserPool {
   #settings;
   #contextPromise;
   #context;
-  #browser;
+  #browser;
+  #extraContexts = new Set();
+  #extraBrowsers = new Set();
+  #contextBrowsers = new Map();
   #page;
   #startedAt;
-  #everStarted = false;
-  #navigationError;
+  #everStarted = false;
+  #navigationError;
+  #unrestoredPage = false;
   #flowQueue = Promise.resolve();
   #configurationKey;
+  #lastConfiguration = {};
 
   constructor(settings) {
     this.#settings = settings;
   }
 
-  getNavigationError() {
-    return this.#navigationError;
-  }
-
-  setNavigationError(error) {
-    this.#navigationError = error || undefined;
+  getNavigationError() {
+    return this.#unrestoredPage ? "BROWSER_PAGE_NOT_RESTORED" : this.#navigationError;
+  }
+
+  setNavigationError(error) {
+    this.#navigationError = error || undefined;
+    this.#unrestoredPage = error === "BROWSER_PAGE_NOT_RESTORED";
   }
 
   async runFlow(work) {
@@ -46,9 +87,12 @@ class BrowserPool {
     } finally {
       release();
     }
-  }
-
-  async getPage(configuration = {}) {
+  }
+
+  async getPage(configuration) {
+    const hadStartedBeforeRequest = this.#everStarted;
+    if (configuration === undefined) configuration = this.#lastConfiguration;
+    else this.#lastConfiguration = configuration;
     const configurationKey = JSON.stringify(configuration);
     if (this.#contextPromise && this.#configurationKey !== configurationKey) await this.close();
     let isOpening = !this.#contextPromise;
@@ -75,7 +119,12 @@ class BrowserPool {
         throw error;
       }
     }
-    return { page: this.#page, context: this.#context, sessionMs: isOpening ? performance.now() - this.#startedAt : 0 };
+    return {
+      page: this.#page,
+      context: this.#context,
+      sessionMs: isOpening ? performance.now() - this.#startedAt : 0,
+      recovered: isOpening && hadStartedBeforeRequest,
+    };
   }
 
   #invalidate(reason) {
@@ -102,7 +151,7 @@ class BrowserPool {
     await this.close();
     this.#everStarted = true;
     this.#startedAt = performance.now();
-    this.#contextPromise = this.#open();
+    this.#contextPromise = this.#open(this.#lastConfiguration);
     try {
       await this.#contextPromise;
       return { status: "connected", connected: true, recovered: true, restarted: true, current_url: this.#page.url() };
@@ -115,6 +164,44 @@ class BrowserPool {
     if (this.#page !== page || !this.#context) return;
     this.#page = this.#context.pages()[0] || await this.#context.newPage();
   }
+
+  async createIsolatedContext(contextOptions = {}, launchArgs = []) {
+    let browser = this.#browser;
+    let ownsBrowser = false;
+    if (!browser) {
+      browser = await chromium.launch({
+        channel: this.#settings.browser.channel,
+        headless: this.#settings.browser.mode !== "computer",
+        args: launchArgs,
+      });
+      ownsBrowser = true;
+    }
+    try {
+      const context = await browser.newContext(contextOptions);
+      this.#extraContexts.add(context);
+      this.#contextBrowsers.set(context, { browser, ownsBrowser });
+      context.once("close", () => this.#extraContexts.delete(context));
+      if (ownsBrowser) {
+        this.#extraBrowsers.add(browser);
+        browser.once("disconnected", () => this.#extraBrowsers.delete(browser));
+      }
+      return context;
+    } catch (error) {
+      if (ownsBrowser) await browser.close().catch(() => {});
+      throw error;
+    }
+  }
+
+  async releaseContext(context) {
+    const ownership = this.#contextBrowsers.get(context);
+    await context?.close().catch(() => {});
+    this.#extraContexts.delete(context);
+    this.#contextBrowsers.delete(context);
+    if (ownership?.ownsBrowser) {
+      await ownership.browser.close().catch(() => {});
+      this.#extraBrowsers.delete(ownership.browser);
+    }
+  }
 
   #watchContext(context, browser) {
     context.once("close", () => {
@@ -125,8 +212,9 @@ class BrowserPool {
     });
   }
 
-  async #open({ contextOptions = {}, launchArgs = [] } = {}) {
-    const { mode, channel, profileDir } = this.#settings.browser;
+  async #open({ contextOptions = {}, launchArgs = [], profileDir: configuredProfileDir } = {}) {
+    const { mode, channel } = this.#settings.browser;
+    const profileDir = configuredProfileDir || this.#settings.browser.profileDir;
     try {
       if (mode === "computer") {
         this.#context = await chromium.launchPersistentContext(profileDir, {
@@ -156,7 +244,12 @@ class BrowserPool {
     }
   }
 
-  async close() {
+  async close() {
+    await Promise.all([...this.#extraContexts].map((context) => this.releaseContext(context)));
+    await Promise.all([...this.#extraBrowsers].map((browser) => browser.close().catch(() => {})));
+    this.#extraContexts.clear();
+    this.#extraBrowsers.clear();
+    this.#contextBrowsers.clear();
     if (this.#context) await this.#context.close().catch(() => {});
     if (this.#browser) await this.#browser.close().catch(() => {});
     this.#context = undefined;
@@ -165,17 +258,47 @@ class BrowserPool {
     this.#contextPromise = undefined;
     this.#navigationError = undefined;
     this.#configurationKey = undefined;
+    this.#unrestoredPage = false;
   }
 }
 
-function toolError(error, settings) {
-  let message = error instanceof JevBrowserError ? error.message : error?.message || `Jev browser flow failed (${error?.name || "Error"})`;
-  const credential = settings.env?.[settings.jev.credentialEnv];
-  if (credential) message = message.split(credential).join("[redacted]");
-  message = message.replace(/\bBearer\s+\S+/gi, "Bearer [redacted]")
-    .replace(/([?&](?:token|api[_-]?key|password|secret)=)[^&\s]+/gi, "$1[redacted]");
-  return { isError: true, content: [{ type: "text", text: `[jev-browser ${packageManifest.version}] ${message}` }] };
-}
+function safeErrorMessage(error, settings) {
+  let message = error instanceof JevBrowserError ? error.message : error?.message || `Jev browser flow failed (${error?.name || "Error"})`;
+  const credential = settings.env?.[settings.jev.credentialEnv];
+  if (credential) message = message.split(credential).join("[redacted]");
+  message = message.replace(/\bBearer\s+\S+/gi, "Bearer [redacted]")
+    .replace(/([?&](?:token|api[_-]?key|password|secret)=)[^&\s]+/gi, "$1[redacted]");
+  return message;
+}
+
+function toolError(error, settings) {
+  const message = safeErrorMessage(error, settings);
+  return { isError: true, content: [{ type: "text", text: `[jev-browser ${packageManifest.version}] ${message}` }] };
+}
+
+function isBrowserDisconnectError(error) {
+  return /(?:target page, context or browser has been closed|browser has been closed|browser disconnected|context has been closed|connection closed|connection is closed)/i
+    .test(String(error?.message || error?.name || error || ""));
+}
+
+function isBrowserStartupError(error) {
+  return /(?:could not start the configured .* browser|browser profile is in use by PID \d+)/i
+    .test(String(error?.message || error?.name || error || ""));
+}
+
+function browserEnvironmentError(reason, navigationError, extra = {}) {
+  return {
+    server_version: packageManifest.version,
+    status: "environment_error",
+    navigation_error: navigationError,
+    reason,
+    acceptance_criteria_met: false,
+    expected_outcome_visible: false,
+    steps_executed: 0,
+    steps: [],
+    ...extra,
+  };
+}
 
 export function fitToolResponse(value, maxBytes) {
   const clone = structuredClone(value && typeof value === "object" ? value : { result: value });
@@ -290,11 +413,33 @@ export function createJevBrowserServer({ env = process.env, configPath, fetchImp
       description: "Check the managed browser connection; set restart=true to close and restart only the browser session owned by this MCP process.",
       inputSchema: { restart: z.boolean().optional() },
     },
-    async ({ restart = false } = {}) => toolText(
-      restart ? await browserPool.restart() : await browserPool.health(),
-      settings.browser.maxToolResponseBytes,
-    ),
-  );
+    async ({ restart = false } = {}) => {
+      const health = restart ? await browserPool.restart() : await browserPool.health();
+      return toolText({
+        ...health,
+        server_version: packageManifest.version,
+        browser_mode: settings.browser.mode,
+        session_id: settings.browser.sessionId,
+        capabilities: {
+          actions: Object.keys(describeBrowserActions().actions),
+          options: describeBrowserActions().options,
+          media_permissions: ["microphone", "geolocation"],
+          fake_media: "WAV audio input",
+          storage_state: "named account snapshots",
+          contexts: ["current", "new isolated context"],
+        },
+      }, settings.browser.maxToolResponseBytes);
+    },
+  );
+
+  server.registerTool(
+    "describe_actions",
+    {
+      description: "Return the live JSON contract for every supported Jev Browser MCP action, option, alias, timeout and placeholder rule.",
+      inputSchema: {},
+    },
+    async () => toolText({ server_version: packageManifest.version, ...describeBrowserActions() }, settings.browser.maxToolResponseBytes),
+  );
 
   server.registerTool(
     "choose_next_action",
@@ -320,42 +465,98 @@ export function createJevBrowserServer({ env = process.env, configPath, fetchImp
     },
   );
 
-  server.registerTool(
-    "run_browser_flow",
-    {
-      description: "Run a bounded screen flow in a warm Playwright session. Continues the current same-origin page by default without repeating navigation. Supports role and label locators, exact row scopes, guarded dialog confirmation, network assertions, variables and extraction, AngularJS idle waits, field-value/enabled waits, dry runs before mutating steps, per-step timing and screenshots, Markdown/JUnit reports, uploads, downloads, accessibility audits, and clear navigation diagnostics. Jev chooses among supplied plans; one plan skips the decision call when fast_path is enabled.",
-      inputSchema: {
-        flow: z.string(),
-        initial_url: z.string(),
-        expected_outcome: z.string(),
-        candidate_plans: z.record(z.string(), z.unknown()),
-        params: z.record(z.string(), z.unknown()).optional(),
-        options: z.record(z.string(), z.unknown()).optional(),
-      },
-    },
-    async ({ flow, initial_url: initialUrl, expected_outcome: expectedOutcome, candidate_plans: candidatePlans, params, options }) => {
-      try {
+  server.registerTool(
+    "run_browser_flow",
+    {
+      description: "Run a bounded screen flow in an isolated per-server browser profile. Continues the current SPA page by default. Supports media fakes, tabs and contexts, read-only page inspection, conditional plans, HTTP/network/WebSocket assertions, named storage state, guarded mutation confirmation, per-step timeouts and evidence. expected_outcome accepts descriptive text or structured text/request assertions. Use describe_actions for required and optional fields and the exact options contract. Jev chooses among eligible supplied plans; a single plan skips the decision call when fast_path is enabled.",
+      inputSchema: {
+        flow: z.string().optional(),
+        initial_url: z.string().optional(),
+        expected_outcome: expectedOutcomeSchema.optional(),
+        candidate_plans: z.record(z.string(), candidatePlanSchema).optional(),
+        params: z.record(z.string(), z.unknown()).optional(),
+        options: browserOptionsSchema.optional(),
+      },
+    },
+    async ({ flow, initial_url: initialUrl, expected_outcome: expectedOutcome, candidate_plans: candidatePlans, params, options }) => {
+      try {
+        const contractIssues = collectFlowContractIssues({ flow, candidatePlans });
+        if (contractIssues.length) throw new JevBrowserError(`flow contract validation failed:\n- ${contractIssues.join("\n- ")}`);
         return toolText(await browserPool.runFlow(async () => {
-          const args = {
-          flow,
-          initialUrl,
-          expectedOutcome,
-          candidatePlans,
-          params,
-          options,
-          settings,
-          browserPool,
-          fetchImpl,
-          serverVersion: packageManifest.version,
-          mutationAuthorizationStore,
-          };
-          const first = await executeBrowserFlow(args);
-          if (first.status !== "environment_error" || first.navigation_error !== "BROWSER_DISCONNECTED"
-            || first.mutating_steps?.length || options?.confirmation_token) return first;
-          const recovery = await browserPool.restart();
-          if (!recovery.connected) return { ...first, browser_restart: recovery, retry_count: 0 };
-          const retry = await executeBrowserFlow({ ...args, options: { ...options, reuse_page: false } });
-          return { ...retry, browser_restart: recovery, retry_count: 1 };
+          const args = {
+            flow,
+            initialUrl,
+            expectedOutcome,
+            candidatePlans,
+            params,
+            options,
+            settings,
+            browserPool,
+            fetchImpl,
+            serverVersion: packageManifest.version,
+            mutationAuthorizationStore,
+          };
+          const retryAfterRestart = async (first) => {
+            const recovery = await browserPool.restart();
+            if (recovery.reason) recovery.reason = safeErrorMessage(new Error(recovery.reason), settings);
+            if (!recovery.connected) {
+              if (!initialUrl) browserPool.setNavigationError("BROWSER_PAGE_NOT_RESTORED");
+              return {
+                ...first,
+                ...(initialUrl ? {} : { navigation_error: "BROWSER_PAGE_NOT_RESTORED" }),
+                browser_restart: recovery,
+                retry_count: 0,
+              };
+            }
+            if (!initialUrl) {
+              browserPool.setNavigationError("BROWSER_PAGE_NOT_RESTORED");
+              return {
+                ...first,
+                navigation_error: "BROWSER_PAGE_NOT_RESTORED",
+                reason: "The browser reconnected, but the previous page was not restored. Provide initial_url to start a new navigation.",
+                browser_restart: recovery,
+                retry_count: 0,
+              };
+            }
+            try {
+              const retry = await executeBrowserFlow({ ...args, options: { ...options, reuse_page: false } });
+              return { ...retry, browser_restart: recovery, retry_count: 1 };
+            } catch (error) {
+              if (!isBrowserDisconnectError(error) && !isBrowserStartupError(error)) throw error;
+              return {
+                ...browserEnvironmentError(
+                  `The browser reconnected, but the flow could not restart: ${safeErrorMessage(error, settings)}`,
+                  "BROWSER_RESTART_FAILED",
+                ),
+                browser_restart: recovery,
+                retry_count: 1,
+              };
+            }
+          };
+
+          let first;
+          try {
+            first = await executeBrowserFlow(args);
+          } catch (error) {
+            if (isBrowserStartupError(error)) {
+              const profileInUse = /browser profile is in use by PID \d+/i.test(String(error.message || ""));
+              return browserEnvironmentError(
+                safeErrorMessage(error, settings),
+                profileInUse ? "BROWSER_PROFILE_IN_USE" : "BROWSER_START_FAILED",
+                { retry_count: 0 },
+              );
+            }
+            if (!isBrowserDisconnectError(error)) throw error;
+            const failedBeforeSteps = browserEnvironmentError(
+              "The browser disconnected before the flow could obtain its page.",
+              "BROWSER_DISCONNECTED",
+            );
+            return retryAfterRestart(failedBeforeSteps);
+          }
+          const disconnected = /^(?:BROWSER_DISCONNECTED|CONNECTION_CLOSED)$/.test(String(first.navigation_error || ""));
+          if (first.status !== "environment_error" || !disconnected
+            || first.steps_executed > 0 || first.mutating_steps?.length || options?.confirmation_token) return first;
+          return retryAfterRestart(first);
         }), settings.browser.maxToolResponseBytes);
       } catch (error) {
         return toolError(error, settings);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diegosouzacdv/jev-browser-mcp",
-  "version": "0.6.2",
+  "version": "0.7.1",
   "description": "Portable MCP server for bounded Playwright screen flows selected by Jev",
   "license": "MIT",
   "repository": {