Skip to main content
Glama

start_codegen_session

Initiates a code generation session to record Playwright automation actions, saving tests to a specified directory with optional test name prefixes and comments.

Instructions

Start a new code generation session to record Playwright actions

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
optionsYesCode generation options

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions recording Playwright actions, but lacks details on session lifecycle, permissions, rate limits, or what happens if a session is already active. For a tool that initiates a stateful process, this is a significant gap in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and appropriately sized, with every part contributing to understanding the tool's function.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of starting a code generation session with no annotations and no output schema, the description is incomplete. It doesn't explain what the tool returns, how the session interacts with other tools, or error conditions. For a state-initiating tool, more context is needed to guide effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents the single parameter 'options' and its nested properties. The description adds no additional parameter semantics beyond what the schema provides, such as default values or usage examples. With high schema coverage, the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Start a new code generation session') and the resource ('to record Playwright actions'), making the purpose evident. It distinguishes from siblings like 'clear_codegen_session' or 'end_codegen_session' by specifying the initiation of a session, though it doesn't explicitly contrast with all siblings like 'get_codegen_session'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, such as needing an active Playwright context, or when to choose this over other session-related tools like 'get_codegen_session'. Usage is implied only by the verb 'start', but no explicit context or exclusions are provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.