playwright_console_logs
Retrieve and filter browser console logs for debugging and monitoring. Search logs by type or text, set retrieval limits, and optionally clear logs after extraction.
Instructions
Retrieve console logs from the browser with filtering options
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clear | No | Whether to clear logs after retrieval (default: false) | |
| limit | No | Maximum number of logs to return | |
| search | No | Text to search for in logs (handles text with square brackets) | |
| type | No | Type of logs to retrieve (all, error, warning, log, info, debug, exception) |
Implementation Reference
- src/tools/browser/console.ts:23-58 (handler)Executes the tool: filters console logs by type, search term, limit, clears if requested, and returns formatted response.async execute(args: any, context: ToolContext): Promise<ToolResponse> { // No need to use safeExecute here as we don't need to interact with the page // We're just filtering and returning logs that are already stored let logs = [...this.consoleLogs]; // Filter by type if specified if (args.type && args.type !== 'all') { logs = logs.filter(log => log.startsWith(`[${args.type}]`)); } // Filter by search text if specified if (args.search) { logs = logs.filter(log => log.includes(args.search)); } // Limit the number of logs if specified if (args.limit && args.limit > 0) { logs = logs.slice(-args.limit); } // Clear logs if requested if (args.clear) { this.consoleLogs = []; } // Format the response if (logs.length === 0) { return createSuccessResponse("No console logs matching the criteria"); } else { return createSuccessResponse([ `Retrieved ${logs.length} console log(s):`, ...logs ]); } }
- src/tools.ts:196-221 (schema)Tool specification including name, description, and input schema definition.name: "playwright_console_logs", description: "Retrieve console logs from the browser with filtering options", inputSchema: { type: "object", properties: { type: { type: "string", description: "Type of logs to retrieve (all, error, warning, log, info, debug, exception)", enum: ["all", "error", "warning", "log", "info", "debug", "exception"] }, search: { type: "string", description: "Text to search for in logs (handles text with square brackets)" }, limit: { type: "number", description: "Maximum number of logs to return" }, clear: { type: "boolean", description: "Whether to clear logs after retrieval (default: false)" } }, required: [], }, },
- src/toolHandler.ts:472-474 (registration)Switch case in handleToolCall that dispatches to consoleLogsTool.execute()case "playwright_console_logs": return await consoleLogsTool.execute(args, context);
- src/tools/browser/console.ts:15-18 (helper)registerConsoleMessage method: stores console messages in the tool's log array.registerConsoleMessage(type: string, text: string): void { const logEntry = `[${type}] ${text}`; this.consoleLogs.push(logEntry); }
- src/toolHandler.ts:113-151 (helper)Sets up Playwright page event listeners (console, pageerror, unhandledrejection) to capture and register console logs via the tool.async function registerConsoleMessage(page) { page.on("console", (msg) => { if (consoleLogsTool) { const type = msg.type(); const text = msg.text(); // "Unhandled Rejection In Promise" we injected if (text.startsWith("[Playwright]")) { const payload = text.replace("[Playwright]", ""); consoleLogsTool.registerConsoleMessage("exception", payload); } else { consoleLogsTool.registerConsoleMessage(type, text); } } }); // Uncaught exception page.on("pageerror", (error) => { if (consoleLogsTool) { const message = error.message; const stack = error.stack || ""; consoleLogsTool.registerConsoleMessage("exception", `${message}\n${stack}`); } }); // Unhandled rejection in promise await page.addInitScript(() => { window.addEventListener("unhandledrejection", (event) => { const reason = event.reason; const message = typeof reason === "object" && reason !== null ? reason.message || JSON.stringify(reason) : String(reason); const stack = reason?.stack || ""; // Use console.error get "Unhandled Rejection In Promise" console.error(`[Playwright][Unhandled Rejection In Promise] ${message}\n${stack}`); }); }); }