@pedropaulovc/playwright 1.59.0-next

package/lib/mcp/terminal/help.json

@@ -0,0 +1,47 @@
+{
+  "global": "Usage: playwright-cli <command> [args] [options]\n\nCore:\n  open <url>                  open url\n  close                       close the page\n  type <text>                 type text into editable element\n  click <ref> [button]        perform click on a web page\n  dblclick <ref> [button]     perform double click on a web page\n  fill <ref> <text>           fill text into editable element\n  drag <startRef> <endRef>    perform drag and drop between two elements\n  hover <ref>                 hover over element on page\n  select <ref> <vals>         select an option in a dropdown\n  upload <file>               upload one or multiple files\n  check <ref>                 check a checkbox or radio button\n  uncheck <ref>               uncheck a checkbox or radio button\n  snapshot                    capture page snapshot to obtain element ref\n  eval <func> [ref]           evaluate javascript expression on page or element\n  dialog-accept [prompt]      accept a dialog\n  dialog-dismiss              dismiss a dialog\n  resize <w> <h>              resize the browser window\n\nNavigation:\n  go-back                     go back to the previous page\n  go-forward                  go forward to the next page\n  reload                      reload the current page\n\nKeyboard:\n  key-press <key>             press a key on the keyboard, `a`, `arrowleft`\n  key-down <key>              press a key down on the keyboard\n  key-up <key>                press a key up on the keyboard\n\nMouse:\n  mouse-move <x> <y>          move mouse to a given position\n  mouse-down [button]         press mouse down\n  mouse-up [button]           press mouse up\n  mouse-wheel <dx> <dy>       scroll mouse wheel\n\nSave as:\n  screenshot [ref]            screenshot of the current page or element\n  pdf                         save page as pdf\n\nTabs:\n  tab-list                    list all tabs\n  tab-new [url]               create a new tab\n  tab-close [index]           close a browser tab\n  tab-select <index>          select a browser tab\n\nDevTools:\n  console [min-level]         list console messages\n  network                     list all network requests since loading the page\n  run-code <code>             run playwright code snippet\n  tracing-start               start trace recording\n  tracing-stop                stop trace recording\n\nSessions:\n  session-list                list all sessions\n  session-stop [name]         stop session\n  session-stop-all            stop all sessions\n  session-delete [name]       delete session data",
+  "commands": {
+    "open": "playwright-cli open <url>\n\nOpen URL\n\nArguments:\n  <url>                       the url to navigate to\nOptions:\n  --headed                    run browser in headed mode",
+    "close": "playwright-cli close \n\nClose the page\n",
+    "type": "playwright-cli type <text>\n\nType text into editable element\n\nArguments:\n  <text>                      text to type into the element\nOptions:\n  --submit                    whether to submit entered text (press enter after)",
+    "click": "playwright-cli click <ref> [button]\n\nPerform click on a web page\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot\n  [button]                    button to click, defaults to left\nOptions:\n  --modifiers                 modifier keys to press",
+    "dblclick": "playwright-cli dblclick <ref> [button]\n\nPerform double click on a web page\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot\n  [button]                    button to click, defaults to left\nOptions:\n  --modifiers                 modifier keys to press",
+    "fill": "playwright-cli fill <ref> <text>\n\nFill text into editable element\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot\n  <text>                      text to fill into the element\nOptions:\n  --submit                    whether to submit entered text (press enter after)",
+    "drag": "playwright-cli drag <startRef> <endRef>\n\nPerform drag and drop between two elements\n\nArguments:\n  <startRef>                  exact source element reference from the page snapshot\n  <endRef>                    exact target element reference from the page snapshot\nOptions:\n  --headed                    run browser in headed mode",
+    "hover": "playwright-cli hover <ref>\n\nHover over element on page\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot",
+    "select": "playwright-cli select <ref> <vals>\n\nSelect an option in a dropdown\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot\n  <vals>                      array of values to select in the dropdown. this can be a single value or multiple values.",
+    "upload": "playwright-cli upload <file>\n\nUpload one or multiple files\n\nArguments:\n  <file>                      the absolute paths to the files to upload",
+    "check": "playwright-cli check <ref>\n\nCheck a checkbox or radio button\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot",
+    "uncheck": "playwright-cli uncheck <ref>\n\nUncheck a checkbox or radio button\n\nArguments:\n  <ref>                       exact target element reference from the page snapshot",
+    "snapshot": "playwright-cli snapshot \n\nCapture page snapshot to obtain element ref\n\nOptions:\n  --filename                  save snapshot to markdown file instead of returning it in the response.",
+    "eval": "playwright-cli eval <func> [ref]\n\nEvaluate JavaScript expression on page or element\n\nArguments:\n  <func>                      () => { /* code */ } or (element) => { /* code */ } when element is provided\n  [ref]                       exact target element reference from the page snapshot",
+    "console": "playwright-cli console [min-level]\n\nList console messages\n\nArguments:\n  [min-level]                 level of the console messages to return. each level includes the messages of more severe levels. defaults to \"info\".\nOptions:\n  --clear                     whether to clear the console list",
+    "dialog-accept": "playwright-cli dialog-accept [prompt]\n\nAccept a dialog\n\nArguments:\n  [prompt]                    the text of the prompt in case of a prompt dialog.",
+    "dialog-dismiss": "playwright-cli dialog-dismiss \n\nDismiss a dialog\n",
+    "resize": "playwright-cli resize <w> <h>\n\nResize the browser window\n\nArguments:\n  <w>                         width of the browser window\n  <h>                         height of the browser window",
+    "go-back": "playwright-cli go-back \n\nGo back to the previous page\n",
+    "go-forward": "playwright-cli go-forward \n\nGo forward to the next page\n",
+    "reload": "playwright-cli reload \n\nReload the current page\n",
+    "key-press": "playwright-cli key-press <key>\n\nPress a key on the keyboard, `a`, `ArrowLeft`\n\nArguments:\n  <key>                       name of the key to press or a character to generate, such as `arrowleft` or `a`",
+    "key-down": "playwright-cli key-down <key>\n\nPress a key down on the keyboard\n\nArguments:\n  <key>                       name of the key to press or a character to generate, such as `arrowleft` or `a`",
+    "key-up": "playwright-cli key-up <key>\n\nPress a key up on the keyboard\n\nArguments:\n  <key>                       name of the key to press or a character to generate, such as `arrowleft` or `a`",
+    "mouse-move": "playwright-cli mouse-move <x> <y>\n\nMove mouse to a given position\n\nArguments:\n  <x>                         x coordinate\n  <y>                         y coordinate",
+    "mouse-down": "playwright-cli mouse-down [button]\n\nPress mouse down\n\nArguments:\n  [button]                    button to press, defaults to left",
+    "mouse-up": "playwright-cli mouse-up [button]\n\nPress mouse up\n\nArguments:\n  [button]                    button to press, defaults to left",
+    "mouse-wheel": "playwright-cli mouse-wheel <dx> <dy>\n\nScroll mouse wheel\n\nArguments:\n  <dx>                        y delta\n  <dy>                        x delta",
+    "screenshot": "playwright-cli screenshot [ref]\n\nscreenshot of the current page or element\n\nArguments:\n  [ref]                       exact target element reference from the page snapshot.\nOptions:\n  --filename                  file name to save the screenshot to. defaults to `page-{timestamp}.{png|jpeg}` if not specified.\n  --fullPage                  when true, takes a screenshot of the full scrollable page, instead of the currently visible viewport.",
+    "pdf": "playwright-cli pdf \n\nSave page as PDF\n\nOptions:\n  --filename                  file name to save the pdf to. defaults to `page-{timestamp}.pdf` if not specified.",
+    "tab-list": "playwright-cli tab-list \n\nList all tabs\n",
+    "tab-new": "playwright-cli tab-new [url]\n\nCreate a new tab\n\nArguments:\n  [url]                       the url to navigate to in the new tab. if omitted, the new tab will be blank.",
+    "tab-close": "playwright-cli tab-close [index]\n\nClose a browser tab\n\nArguments:\n  [index]                     tab index. if omitted, current tab is closed.",
+    "tab-select": "playwright-cli tab-select <index>\n\nSelect a browser tab\n\nArguments:\n  <index>                     tab index",
+    "network": "playwright-cli network \n\nList all network requests since loading the page\n\nOptions:\n  --static                    whether to include successful static resources like images, fonts, scripts, etc. defaults to false.\n  --clear                     whether to clear the network list",
+    "run-code": "playwright-cli run-code <code>\n\nRun Playwright code snippet\n\nArguments:\n  <code>                      a javascript function containing playwright code to execute. it will be invoked with a single argument, page, which you can use for any page interaction.",
+    "tracing-start": "playwright-cli tracing-start \n\nStart trace recording\n",
+    "tracing-stop": "playwright-cli tracing-stop \n\nStop trace recording\n",
+    "session-list": "playwright-cli session-list \n\nList all sessions\n",
+    "session-stop": "playwright-cli session-stop [name]\n\nStop session\n\nArguments:\n  [name]                      name of the session to stop. if omitted, current session is stopped.",
+    "session-stop-all": "playwright-cli session-stop-all \n\nStop all sessions\n",
+    "session-delete": "playwright-cli session-delete [name]\n\nDelete session data\n\nArguments:\n  [name]                      name of the session to delete. if omitted, current session is deleted."
+  }
+}

package/lib/mcp/terminal/helpGenerator.js

@@ -0,0 +1,115 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_commands = require("./commands");
+function commandArgs(command) {
+  const args = [];
+  const shape = command.args ? command.args.shape : {};
+  for (const [name, schema] of Object.entries(shape)) {
+    const zodSchema = schema;
+    const description = zodSchema.description ?? "";
+    args.push({ name, description, optional: zodSchema.safeParse(void 0).success });
+  }
+  return args;
+}
+function commandArgsText(args) {
+  return args.map((a) => a.optional ? `[${a.name}]` : `<${a.name}>`).join(" ");
+}
+function generateCommandHelp(command) {
+  const args = commandArgs(command);
+  const lines = [
+    `playwright-cli ${command.name} ${commandArgsText(args)}`,
+    "",
+    command.description,
+    ""
+  ];
+  if (args.length) {
+    lines.push("Arguments:");
+    lines.push(...args.map((a) => formatWithGap(`  ${a.optional ? `[${a.name}]` : `<${a.name}>`}`, a.description.toLowerCase())));
+  }
+  if (command.options) {
+    lines.push("Options:");
+    const optionsShape = command.options.shape;
+    for (const [name, schema] of Object.entries(optionsShape)) {
+      const zodSchema = schema;
+      const description = (zodSchema.description ?? "").toLowerCase();
+      lines.push(formatWithGap(`  --${name}`, description));
+    }
+  }
+  return lines.join("\n");
+}
+const categories = [
+  { name: "core", title: "Core" },
+  { name: "navigation", title: "Navigation" },
+  { name: "keyboard", title: "Keyboard" },
+  { name: "mouse", title: "Mouse" },
+  { name: "export", title: "Save as" },
+  { name: "tabs", title: "Tabs" },
+  { name: "storage", title: "Storage" },
+  { name: "devtools", title: "DevTools" },
+  { name: "session", title: "Sessions" }
+];
+function generateHelp() {
+  const lines = [];
+  lines.push("Usage: playwright-cli <command> [args] [options]");
+  const commandsByCategory = /* @__PURE__ */ new Map();
+  for (const c of categories)
+    commandsByCategory.set(c.name, []);
+  for (const command of Object.values(import_commands.commands))
+    commandsByCategory.get(command.category).push(command);
+  for (const c of categories) {
+    const cc = commandsByCategory.get(c.name);
+    if (!cc.length)
+      continue;
+    lines.push(`
+${c.title}:`);
+    for (const command of cc)
+      lines.push(generateHelpEntry(command));
+  }
+  return lines.join("\n");
+}
+function generateHelpEntry(command) {
+  const args = commandArgs(command);
+  const prefix = `  ${command.name} ${commandArgsText(args)}`;
+  const suffix = command.description.toLowerCase();
+  return formatWithGap(prefix, suffix);
+}
+async function main() {
+  const help = {
+    global: generateHelp(),
+    commands: Object.fromEntries(
+      Object.entries(import_commands.commands).map(([name, command]) => [name, generateCommandHelp(command)])
+    )
+  };
+  const fileName = import_path.default.resolve(__dirname, "help.json").replace("lib", "src");
+  console.log("Writing ", import_path.default.relative(process.cwd(), fileName));
+  await import_fs.default.promises.writeFile(fileName, JSON.stringify(help, null, 2));
+  console.log(help.global);
+}
+function formatWithGap(prefix, text) {
+  const indent = Math.max(1, 30 - prefix.length);
+  return prefix + " ".repeat(indent) + text;
+}
+void main();

package/lib/mcp/terminal/socketConnection.js

@@ -0,0 +1,80 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var socketConnection_exports = {};
+__export(socketConnection_exports, {
+  SocketConnection: () => SocketConnection
+});
+module.exports = __toCommonJS(socketConnection_exports);
+var import_utilsBundle = require("playwright-core/lib/utilsBundle");
+const daemonDebug = (0, import_utilsBundle.debug)("pw:daemon");
+class SocketConnection {
+  constructor(socket) {
+    this._pendingBuffers = [];
+    this._socket = socket;
+    socket.on("data", (buffer) => this._onData(buffer));
+    socket.on("close", () => {
+      this.onclose?.();
+    });
+    socket.on("error", (e) => daemonDebug(`error: ${e.message}`));
+  }
+  async send(message) {
+    await new Promise((resolve, reject) => {
+      this._socket.write(`${JSON.stringify(message)}
+`, (error) => {
+        if (error)
+          reject(error);
+        else
+          resolve(void 0);
+      });
+    });
+  }
+  close() {
+    this._socket.destroy();
+  }
+  _onData(buffer) {
+    let end = buffer.indexOf("\n");
+    if (end === -1) {
+      this._pendingBuffers.push(buffer);
+      return;
+    }
+    this._pendingBuffers.push(buffer.slice(0, end));
+    const message = Buffer.concat(this._pendingBuffers).toString();
+    this._dispatchMessage(message);
+    let start = end + 1;
+    end = buffer.indexOf("\n", start);
+    while (end !== -1) {
+      const message2 = buffer.toString(void 0, start, end);
+      this._dispatchMessage(message2);
+      start = end + 1;
+      end = buffer.indexOf("\n", start);
+    }
+    this._pendingBuffers = [buffer.slice(start)];
+  }
+  _dispatchMessage(message) {
+    try {
+      this.onmessage?.(JSON.parse(message));
+    } catch (e) {
+      daemonDebug("failed to dispatch message", e);
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SocketConnection
+});

package/lib/mcp/test/browserBackend.js

@@ -0,0 +1,98 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var browserBackend_exports = {};
+__export(browserBackend_exports, {
+  createCustomMessageHandler: () => createCustomMessageHandler
+});
+module.exports = __toCommonJS(browserBackend_exports);
+var import_config = require("../browser/config");
+var import_browserServerBackend = require("../browser/browserServerBackend");
+var import_tab = require("../browser/tab");
+var import_util = require("../../util");
+var import_browserContextFactory = require("../browser/browserContextFactory");
+function createCustomMessageHandler(testInfo, context) {
+  let backend;
+  return async (data) => {
+    if (data.initialize) {
+      if (backend)
+        throw new Error("MCP backend is already initialized");
+      backend = new import_browserServerBackend.BrowserServerBackend({ ...import_config.defaultConfig, capabilities: ["testing"] }, (0, import_browserContextFactory.identityBrowserContextFactory)(context));
+      await backend.initialize(data.initialize.clientInfo);
+      const pausedMessage = await generatePausedMessage(testInfo, context);
+      return { initialize: { pausedMessage } };
+    }
+    if (data.listTools) {
+      if (!backend)
+        throw new Error("MCP backend is not initialized");
+      return { listTools: await backend.listTools() };
+    }
+    if (data.callTool) {
+      if (!backend)
+        throw new Error("MCP backend is not initialized");
+      return { callTool: await backend.callTool(data.callTool.name, data.callTool.arguments) };
+    }
+    if (data.close) {
+      backend?.serverClosed();
+      backend = void 0;
+      return { close: {} };
+    }
+    throw new Error("Unknown MCP request");
+  };
+}
+async function generatePausedMessage(testInfo, context) {
+  const lines = [];
+  if (testInfo.errors.length) {
+    lines.push(`### Paused on error:`);
+    for (const error of testInfo.errors)
+      lines.push((0, import_util.stripAnsiEscapes)(error.message || ""));
+  } else {
+    lines.push(`### Paused at end of test. ready for interaction`);
+  }
+  for (let i = 0; i < context.pages().length; i++) {
+    const page = context.pages()[i];
+    const stateSuffix = context.pages().length > 1 ? i + 1 + " of " + context.pages().length : "state";
+    lines.push(
+      "",
+      `### Page ${stateSuffix}`,
+      `- Page URL: ${page.url()}`,
+      `- Page Title: ${await page.title()}`.trim()
+    );
+    let console = testInfo.errors.length ? await import_tab.Tab.collectConsoleMessages(page) : [];
+    console = console.filter((msg) => msg.type === "error");
+    if (console.length) {
+      lines.push("- Console Messages:");
+      for (const message of console)
+        lines.push(`  - ${message.toString()}`);
+    }
+    lines.push(
+      `- Page Snapshot:`,
+      "```yaml",
+      (await page._snapshotForAI()).full,
+      "```"
+    );
+  }
+  lines.push("");
+  if (testInfo.errors.length)
+    lines.push(`### Task`, `Try recovering from the error prior to continuing`);
+  return lines.join("\n");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createCustomMessageHandler
+});

package/lib/mcp/test/generatorTools.js

@@ -0,0 +1,122 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var generatorTools_exports = {};
+__export(generatorTools_exports, {
+  generatorReadLog: () => generatorReadLog,
+  generatorWriteTest: () => generatorWriteTest,
+  setupPage: () => setupPage
+});
+module.exports = __toCommonJS(generatorTools_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
+var import_testTool = require("./testTool");
+var import_testContext = require("./testContext");
+const setupPage = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "generator_setup_page",
+    title: "Setup generator page",
+    description: "Setup the page for test.",
+    inputSchema: import_mcpBundle.z.object({
+      plan: import_mcpBundle.z.string().describe("The plan for the test. This should be the actual test plan with all the steps."),
+      project: import_mcpBundle.z.string().optional().describe('Project to use for setup. For example: "chromium", if no project is provided uses the first project in the config.'),
+      seedFile: import_mcpBundle.z.string().optional().describe('A seed file contains a single test that is used to setup the page for testing, for example: "tests/seed.spec.ts". If no seed file is provided, a default seed file is created.')
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
+    context.generatorJournal = new import_testContext.GeneratorJournal(context.rootPath, params.plan, seed);
+    const { output, status } = await context.runSeedTest(seed.file, seed.projectName);
+    return { content: [{ type: "text", text: output }], isError: status !== "paused" };
+  }
+});
+const generatorReadLog = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "generator_read_log",
+    title: "Retrieve test log",
+    description: "Retrieve the performed test log",
+    inputSchema: import_mcpBundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context) => {
+    if (!context.generatorJournal)
+      throw new Error(`Please setup page using "${setupPage.schema.name}" first.`);
+    const result = context.generatorJournal.journal();
+    return { content: [{
+      type: "text",
+      text: result
+    }] };
+  }
+});
+const generatorWriteTest = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "generator_write_test",
+    title: "Write test",
+    description: "Write the generated test to the test file",
+    inputSchema: import_mcpBundle.z.object({
+      fileName: import_mcpBundle.z.string().describe("The file to write the test to"),
+      code: import_mcpBundle.z.string().describe("The generated test code")
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    if (!context.generatorJournal)
+      throw new Error(`Please setup page using "${setupPage.schema.name}" first.`);
+    const testRunner = context.existingTestRunner();
+    if (!testRunner)
+      throw new Error("No test runner found, please setup page and perform actions first.");
+    const config = await testRunner.loadConfig();
+    const dirs = [];
+    for (const project of config.projects) {
+      const testDir = import_path.default.relative(context.rootPath, project.project.testDir).replace(/\\/g, "/");
+      const fileName = params.fileName.replace(/\\/g, "/");
+      if (fileName.startsWith(testDir)) {
+        const resolvedFile = import_path.default.resolve(context.rootPath, fileName);
+        await import_fs.default.promises.mkdir(import_path.default.dirname(resolvedFile), { recursive: true });
+        await import_fs.default.promises.writeFile(resolvedFile, params.code);
+        return {
+          content: [{
+            type: "text",
+            text: `### Result
+Test written to ${params.fileName}`
+          }]
+        };
+      }
+      dirs.push(testDir);
+    }
+    throw new Error(`Test file did not match any of the test dirs: ${dirs.join(", ")}`);
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generatorReadLog,
+  generatorWriteTest,
+  setupPage
+});

package/lib/mcp/test/plannerTools.js

@@ -0,0 +1,145 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plannerTools_exports = {};
+__export(plannerTools_exports, {
+  saveTestPlan: () => saveTestPlan,
+  setupPage: () => setupPage,
+  submitTestPlan: () => submitTestPlan
+});
+module.exports = __toCommonJS(plannerTools_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
+var import_testTool = require("./testTool");
+const setupPage = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "planner_setup_page",
+    title: "Setup planner page",
+    description: "Setup the page for test planning",
+    inputSchema: import_mcpBundle.z.object({
+      project: import_mcpBundle.z.string().optional().describe('Project to use for setup. For example: "chromium", if no project is provided uses the first project in the config.'),
+      seedFile: import_mcpBundle.z.string().optional().describe('A seed file contains a single test that is used to setup the page for testing, for example: "tests/seed.spec.ts". If no seed file is provided, a default seed file is created.')
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
+    const { output, status } = await context.runSeedTest(seed.file, seed.projectName);
+    return { content: [{ type: "text", text: output }], isError: status !== "paused" };
+  }
+});
+const planSchema = import_mcpBundle.z.object({
+  overview: import_mcpBundle.z.string().describe("A brief overview of the application to be tested"),
+  suites: import_mcpBundle.z.array(import_mcpBundle.z.object({
+    name: import_mcpBundle.z.string().describe("The name of the suite"),
+    seedFile: import_mcpBundle.z.string().describe("A seed file that was used to setup the page for testing."),
+    tests: import_mcpBundle.z.array(import_mcpBundle.z.object({
+      name: import_mcpBundle.z.string().describe("The name of the test"),
+      file: import_mcpBundle.z.string().describe('The file the test should be saved to, for example: "tests/<suite-name>/<test-name>.spec.ts".'),
+      steps: import_mcpBundle.z.array(import_mcpBundle.z.object({
+        perform: import_mcpBundle.z.string().optional().describe(`Action to perform. For example: 'Click on the "Submit" button'.`),
+        expect: import_mcpBundle.z.string().array().describe(`Expected result of the action where appropriate. For example: 'The page should show the "Thank you for your submission" message'`)
+      }))
+    }))
+  }))
+});
+const submitTestPlan = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "planner_submit_plan",
+    title: "Submit test plan",
+    description: "Submit the test plan to the test planner",
+    inputSchema: planSchema,
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    return {
+      content: [{
+        type: "text",
+        text: JSON.stringify(params, null, 2)
+      }]
+    };
+  }
+});
+const saveTestPlan = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "planner_save_plan",
+    title: "Save test plan as markdown file",
+    description: "Save the test plan as a markdown file",
+    inputSchema: planSchema.extend({
+      name: import_mcpBundle.z.string().describe('The name of the test plan, for example: "Test Plan".'),
+      fileName: import_mcpBundle.z.string().describe('The file to save the test plan to, for example: "spec/test.plan.md". Relative to the workspace root.')
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    const lines = [];
+    lines.push(`# ${params.name}`);
+    lines.push(``);
+    lines.push(`## Application Overview`);
+    lines.push(``);
+    lines.push(params.overview);
+    lines.push(``);
+    lines.push(`## Test Scenarios`);
+    for (let i = 0; i < params.suites.length; i++) {
+      lines.push(``);
+      const suite = params.suites[i];
+      lines.push(`### ${i + 1}. ${suite.name}`);
+      lines.push(``);
+      lines.push(`**Seed:** \`${suite.seedFile}\``);
+      for (let j = 0; j < suite.tests.length; j++) {
+        lines.push(``);
+        const test = suite.tests[j];
+        lines.push(`#### ${i + 1}.${j + 1}. ${test.name}`);
+        lines.push(``);
+        lines.push(`**File:** \`${test.file}\``);
+        lines.push(``);
+        lines.push(`**Steps:**`);
+        for (let k = 0; k < test.steps.length; k++) {
+          lines.push(`  ${k + 1}. ${test.steps[k].perform ?? "-"}`);
+          for (const expect of test.steps[k].expect)
+            lines.push(`    - expect: ${expect}`);
+        }
+      }
+    }
+    lines.push(``);
+    await import_fs.default.promises.writeFile(import_path.default.resolve(context.rootPath, params.fileName), lines.join("\n"));
+    return {
+      content: [{
+        type: "text",
+        text: `Test plan saved to ${params.fileName}`
+      }]
+    };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  saveTestPlan,
+  setupPage,
+  submitTestPlan
+});