Playwright MCP Server

Instructions

Implementation Reference

• src/tools/codegen/index.ts:82-157 (handler)

  Primary implementation of the end_codegen_session tool, defining the Tool object with name, description, parameters schema, and the async handler function that processes the session, generates the Playwright test file using PlaywrightGenerator, writes it to disk, cleans up browser resources, and returns the result.

  export const endCodegenSession: Tool = {
    name: 'end_codegen_session',
    description: 'End the current code generation session and generate Playwright test',
    parameters: {
      type: 'object',
      properties: {
        sessionId: {
          type: 'string',
          description: 'ID of the session to end'
        }
      },
      required: ['sessionId']
    },
    handler: async ({ sessionId }: { sessionId: string }) => {
      try {
        const recorder = ActionRecorder.getInstance();
        const session = recorder.endSession(sessionId);
  
        if (!session) {
          throw new Error(`Session ${sessionId} not found`);
        }
  
        if (!session.options) {
          throw new Error(`Session ${sessionId} has no options configured`);
        }
  
        const generator = new PlaywrightGenerator(session.options);
        const result = await generator.generateTest(session);
  
        // Double check output directory exists
        const outputDir = path.dirname(result.filePath);
        await fs.mkdir(outputDir, { recursive: true });
        
        // Write test file
        try {
          await fs.writeFile(result.filePath, result.testCode, 'utf-8');
        } catch (writeError: any) {
          throw new Error(`Failed to write test file: ${writeError.message}`);
        }
  
        // Close Playwright browser and cleanup
        try {
          if (global.browser?.isConnected()) {
            await global.browser.close();
          }
        } catch (browserError: any) {
          console.warn('Failed to close browser:', browserError.message);
        } finally {
          global.browser = undefined;
          global.page = undefined;
        }
  
        const absolutePath = path.resolve(result.filePath);
  
        return {
          filePath: absolutePath,
          outputDirectory: outputDir,
          testCode: result.testCode,
          message: `Generated test file at: ${absolutePath}\nOutput directory: ${outputDir}`
        };
      } catch (error: any) {
        // Ensure browser cleanup even on error
        try {
          if (global.browser?.isConnected()) {
            await global.browser.close();
          }
        } catch {
          // Ignore cleanup errors
        } finally {
          global.browser = undefined;
          global.page = undefined;
        }
        
        throw new Error(`Failed to end codegen session: ${error.message}`);
      }
    }

• src/tools.ts:36-48 (schema)

  Input schema definition for the end_codegen_session tool, used in createToolDefinitions() for MCP tool registration.

  {
    name: "end_codegen_session",
    description: "End a code generation session and generate the test file",
    inputSchema: {
      type: "object",
      properties: {
        sessionId: { 
          type: "string", 
          description: "ID of the session to end" 
        }
      },
      required: ["sessionId"]
    }

• src/toolHandler.ts:355-364 (registration)

  Registration and dispatch logic in the main handleToolCall function, importing and routing end_codegen_session calls to its handler via switch statement.

  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/toolHandler.ts:7-12 (registration)

  Import statement bringing endCodegenSession Tool into the main tool handler.

  import { 
    startCodegenSession,
    endCodegenSession,
    getCodegenSession,
    clearCodegenSession
  } from './tools/codegen/index.js';

• src/tools/codegen/index.ts:204-206 (registration)

  Export of codegenTools array including endCodegenSession for use by other modules.

  export const codegenTools = [
    startCodegenSession,
    endCodegenSession,