start_codegen_session
Initiate a code generation session to record and save Playwright browser actions as automated tests, specifying output path, test name prefix, and optional comments for clarity.
Instructions
Start a new code generation session to record Playwright actions
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| options | Yes | Code generation options |
Implementation Reference
- src/tools/codegen/index.ts:42-79 (handler)The main execution logic of the start_codegen_session tool. Merges user-provided options with defaults, normalizes paths, creates output directory, initializes ActionRecorder session, stores options, and returns session information.handler: async ({ options = {} }: { options?: CodegenOptions }) => { try { // Merge provided options with defaults const mergedOptions = { ...DEFAULT_OPTIONS, ...options }; // Ensure output path is absolute and normalized const workspaceRoot = getWorkspaceRoot(); const outputPath = path.isAbsolute(mergedOptions.outputPath) ? mergedOptions.outputPath : path.join(workspaceRoot, mergedOptions.outputPath); mergedOptions.outputPath = outputPath; // Ensure output directory exists try { await fs.mkdir(outputPath, { recursive: true }); } catch (mkdirError: any) { throw new Error(`Failed to create output directory: ${mkdirError.message}`); } const sessionId = ActionRecorder.getInstance().startSession(); // Store options with the session const recorder = ActionRecorder.getInstance(); const session = recorder.getSession(sessionId); if (session) { session.options = mergedOptions; } return { sessionId, options: mergedOptions, message: `Started codegen session. Tests will be generated in: ${outputPath}` }; } catch (error: any) { throw new Error(`Failed to start codegen session: ${error.message}`); } }
- src/tools/codegen/index.ts:28-41 (schema)Input schema definition for the tool parameters, defining the optional 'options' object with outputPath, testNamePrefix, and includeComments.parameters: { type: 'object', properties: { options: { type: 'object', description: 'Code generation options', properties: { outputPath: { type: 'string' }, testNamePrefix: { type: 'string' }, includeComments: { type: 'boolean' } } } } },
- src/toolHandler.ts:364-372 (registration)Registration and dispatching logic in the main tool handler switch statement, calling the tool's handler function via handleCodegenResult.switch (name) { case 'start_codegen_session': return await handleCodegenResult(startCodegenSession.handler(args)); case 'end_codegen_session': return await handleCodegenResult(endCodegenSession.handler(args)); case 'get_codegen_session': return await handleCodegenResult(getCodegenSession.handler(args)); case 'clear_codegen_session': return await handleCodegenResult(clearCodegenSession.handler(args));
- src/tools.ts:7-35 (schema)MCP-compatible tool definition including detailed inputSchema for registration in createToolDefinitions().{ name: "start_codegen_session", description: "Start a new code generation session to record Playwright actions", inputSchema: { type: "object", properties: { options: { type: "object", description: "Code generation options", properties: { outputPath: { type: "string", description: "Directory path where generated tests will be saved (use absolute path)" }, testNamePrefix: { type: "string", description: "Prefix to use for generated test names (default: 'GeneratedTest')" }, includeComments: { type: "boolean", description: "Whether to include descriptive comments in generated tests" } }, required: ["outputPath"] } }, required: ["options"] } },
- src/tools.ts:485-490 (registration)List of codegen tools including start_codegen_session for categorization and conditional logic.export const CODEGEN_TOOLS = [ 'start_codegen_session', 'end_codegen_session', 'get_codegen_session', 'clear_codegen_session' ];