@mastra/core 1.9.0 → 1.10.0

package/dist/docs/references/reference-workflows-workflow.md

@@ -21,87 +21,77 @@ export const workflow = createWorkflow({
 
 ## Constructor parameters
 
-**id:** (`string`): Unique identifier for the workflow
+**id** (`string`): Unique identifier for the workflow
 
-**inputSchema:** (`z.ZodType<any>`): Zod schema defining the input structure for the workflow
+**inputSchema** (`z.ZodType<any>`): Zod schema defining the input structure for the workflow
 
-**outputSchema:** (`z.ZodType<any>`): Zod schema defining the output structure for the workflow
+**outputSchema** (`z.ZodType<any>`): Zod schema defining the output structure for the workflow
 
-**stateSchema?:** (`z.ZodObject<any>`): Optional Zod schema for the workflow state. Automatically injected when using Mastra's state system. If not specified, type is 'any'.
+**stateSchema** (`z.ZodObject<any>`): Optional Zod schema for the workflow state. Automatically injected when using Mastra's state system. If not specified, type is 'any'.
 
-**requestContextSchema?:** (`z.ZodType<any>`): Zod schema for validating request context values. When provided, the context is validated at the start of run.start(), throwing an error if validation fails.
+**requestContextSchema** (`z.ZodType<any>`): Zod schema for validating request context values. When provided, the context is validated at the start of run.start(), throwing an error if validation fails.
 
-**options?:** (`WorkflowOptions`): Optional options for the workflow
+**options** (`WorkflowOptions`): Optional options for the workflow
 
-### WorkflowOptions
+**options.tracingPolicy** (`TracingPolicy`): Optional tracing policy for the workflow
 
-**tracingPolicy?:** (`TracingPolicy`): Optional tracing policy for the workflow
+**options.validateInputs** (`boolean`): Optional flag to determine whether to validate the workflow inputs. This also applies default values from zodSchemas on the workflow/step input/resume data. If input/resume data validation fails on start/resume, the workflow will not start/resume, it throws an error instead. If input data validation fails on a step execution, the step fails, causing the workflow to fail and the error is returned.
 
-**validateInputs?:** (`boolean`): Optional flag to determine whether to validate the workflow inputs. This also applies default values from zodSchemas on the workflow/step input/resume data. If input/resume data validation fails on start/resume, the workflow will not start/resume, it throws an error instead. If input data validation fails on a step execution, the step fails, causing the workflow to fail and the error is returned. (Default: `true`)
+**options.shouldPersistSnapshot** (`(params: { stepResults: Record<string, StepResult<any, any, any, any>>; workflowStatus: WorkflowRunStatus }) => boolean`): Optional flag to determine whether to persist the workflow snapshot
 
-**shouldPersistSnapshot?:** (`(params: { stepResults: Record<string, StepResult<any, any, any, any>>; workflowStatus: WorkflowRunStatus }) => boolean`): Optional flag to determine whether to persist the workflow snapshot (Default: `() => true`)
+**options.onFinish** (`(result: WorkflowFinishCallbackResult) => void | Promise<void>`): Callback invoked when workflow completes with any status (success, failed, suspended, tripwire). Receives the workflow result including status, output, error, and step results. Errors thrown in this callback are caught and logged, not propagated.
 
-**onFinish?:** (`(result: WorkflowFinishCallbackResult) => void | Promise<void>`): Callback invoked when workflow completes with any status (success, failed, suspended, tripwire). Receives the workflow result including status, output, error, and step results. Errors thrown in this callback are caught and logged, not propagated.
+**options.onFinish.status** (`WorkflowRunStatus`): The workflow status: 'success', 'failed', 'suspended', or 'tripwire'
 
-**onError?:** (`(errorInfo: WorkflowErrorCallbackInfo) => void | Promise<void>`): Callback invoked only when workflow fails (failed or tripwire status). Receives error details and step results. Errors thrown in this callback are caught and logged, not propagated.
+**options.onFinish.result** (`any`): The workflow output (when status is 'success')
 
-### WorkflowFinishCallbackResult
+**options.onFinish.error** (`SerializedError`): Error details (when status is 'failed')
 
-The result object passed to `onFinish` callbacks.
+**options.onFinish.steps** (`Record<string, StepResult>`): Individual step results with their status and output
 
-**status:** (`WorkflowRunStatus`): The workflow status: 'success', 'failed', 'suspended', or 'tripwire'
+**options.onFinish.tripwire** (`StepTripwireInfo`): Tripwire information (when status is 'tripwire')
 
-**result?:** (`any`): The workflow output (when status is 'success')
+**options.onFinish.runId** (`string`): The unique identifier for this workflow run
 
-**error?:** (`SerializedError`): Error details (when status is 'failed')
+**options.onFinish.workflowId** (`string`): The workflow's identifier
 
-**steps:** (`Record<string, StepResult>`): Individual step results with their status and output
+**options.onFinish.resourceId** (`string`): Optional resource identifier (if provided when creating the run)
 
-**tripwire?:** (`StepTripwireInfo`): Tripwire information (when status is 'tripwire')
+**options.onFinish.getInitData** (`() => any`): Function that returns the initial input data passed to the workflow
 
-**runId:** (`string`): The unique identifier for this workflow run
+**options.onFinish.mastra** (`Mastra`): The Mastra instance (if workflow is registered with Mastra)
 
-**workflowId:** (`string`): The workflow's identifier
+**options.onFinish.requestContext** (`RequestContext`): Request-scoped context data
 
-**resourceId?:** (`string`): Optional resource identifier (if provided when creating the run)
+**options.onFinish.logger** (`IMastraLogger`): The workflow's logger instance
 
-**getInitData:** (`() => any`): Function that returns the initial input data passed to the workflow
+**options.onFinish.state** (`Record<string, any>`): The workflow's current state object
 
-**mastra?:** (`Mastra`): The Mastra instance (if workflow is registered with Mastra)
+**options.onError** (`(errorInfo: WorkflowErrorCallbackInfo) => void | Promise<void>`): Callback invoked only when workflow fails (failed or tripwire status). Receives error details and step results. Errors thrown in this callback are caught and logged, not propagated.
 
-**requestContext:** (`RequestContext`): Request-scoped context data
+**options.onError.status** (`'failed' | 'tripwire'`): The workflow status (either 'failed' or 'tripwire')
 
-**logger:** (`IMastraLogger`): The workflow's logger instance
+**options.onError.error** (`SerializedError`): Error details
 
-**state:** (`Record<string, any>`): The workflow's current state object
+**options.onError.steps** (`Record<string, StepResult>`): Individual step results with their status and output
 
-### WorkflowErrorCallbackInfo
+**options.onError.tripwire** (`StepTripwireInfo`): Tripwire information (when status is 'tripwire')
 
-The error info object passed to `onError` callbacks.
+**options.onError.runId** (`string`): The unique identifier for this workflow run
 
-**status:** (`'failed' | 'tripwire'`): The workflow status (either 'failed' or 'tripwire')
+**options.onError.workflowId** (`string`): The workflow's identifier
 
-**error?:** (`SerializedError`): Error details
+**options.onError.resourceId** (`string`): Optional resource identifier (if provided when creating the run)
 
-**steps:** (`Record<string, StepResult>`): Individual step results with their status and output
+**options.onError.getInitData** (`() => any`): Function that returns the initial input data passed to the workflow
 
-**tripwire?:** (`StepTripwireInfo`): Tripwire information (when status is 'tripwire')
+**options.onError.mastra** (`Mastra`): The Mastra instance (if workflow is registered with Mastra)
 
-**runId:** (`string`): The unique identifier for this workflow run
+**options.onError.requestContext** (`RequestContext`): Request-scoped context data
 
-**workflowId:** (`string`): The workflow's identifier
+**options.onError.logger** (`IMastraLogger`): The workflow's logger instance
 
-**resourceId?:** (`string`): Optional resource identifier (if provided when creating the run)
-
-**getInitData:** (`() => any`): Function that returns the initial input data passed to the workflow
-
-**mastra?:** (`Mastra`): The Mastra instance (if workflow is registered with Mastra)
-
-**requestContext:** (`RequestContext`): Request-scoped context data
-
-**logger:** (`IMastraLogger`): The workflow's logger instance
-
-**state:** (`Record<string, any>`): The workflow's current state object
+**options.onError.state** (`Record<string, any>`): The workflow's current state object
 
 ## Running with initial state
 
@@ -125,13 +115,13 @@ The `initialState` object should match the structure defined in the workflow's `
 
 A workflow's `status` indicates its current execution state. The possible values are:
 
-**success:** (`string`): All steps finished executing successfully, with a valid result output
+**success** (`string`): All steps finished executing successfully, with a valid result output
 
-**failed:** (`string`): Workflow encountered an error during execution, with error details available
+**failed** (`string`): Workflow encountered an error during execution, with error details available
 
-**suspended:** (`string`): Workflow execution is paused waiting for resume, with suspended step information
+**suspended** (`string`): Workflow execution is paused waiting for resume, with suspended step information
 
-**tripwire:** (`string`): Workflow was terminated by a processor tripwire. This occurs when an agent step within the workflow triggers a tripwire (e.g., content was blocked by a guardrail). The tripwire information is available on the result.
+**tripwire** (`string`): Workflow was terminated by a processor tripwire. This occurs when an agent step within the workflow triggers a tripwire (e.g., content was blocked by a guardrail). The tripwire information is available on the result.
 
 ### Handling tripwire status
 

package/dist/docs/references/reference-workspace-filesystem.md

@@ -17,9 +17,9 @@ const buffer = await filesystem.readFile('/image.png', { encoding: 'binary' })
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**options.encoding?:** (`'utf-8' | 'binary'`): Text or binary encoding (Default: `'utf-8'`)
+**options.encoding** (`'utf-8' | 'binary'`): Text or binary encoding (Default: `'utf-8'`)
 
 **Returns:** `Promise<string | Buffer>`
 
@@ -34,13 +34,13 @@ await filesystem.writeFile('/nested/path/file.md', content, { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**content:** (`string | Buffer`): File content
+**content** (`string | Buffer`): File content
 
-**options.recursive?:** (`boolean`): Create parent directories if they don't exist (Default: `false`)
+**options.recursive** (`boolean`): Create parent directories if they don't exist (Default: `false`)
 
-**options.overwrite?:** (`boolean`): Overwrite existing file (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite existing file (Default: `true`)
 
 ### `deleteFile(path, options?)`
 
@@ -53,9 +53,9 @@ await filesystem.deleteFile('/docs/maybe.md', { force: true }) // Don't throw if
 
 **Parameters:**
 
-**path:** (`string`): File path
+**path** (`string`): File path
 
-**options.force?:** (`boolean`): Don't throw error if file doesn't exist (Default: `false`)
+**options.force** (`boolean`): Don't throw error if file doesn't exist (Default: `false`)
 
 ### `appendFile(path, content)`
 
@@ -67,9 +67,9 @@ await filesystem.appendFile('/logs/app.log', 'New log entry\n')
 
 **Parameters:**
 
-**path:** (`string`): File path
+**path** (`string`): File path
 
-**content:** (`string | Buffer`): Content to append
+**content** (`string | Buffer`): Content to append
 
 ### `copyFile(src, dest, options?)`
 
@@ -81,11 +81,11 @@ await filesystem.copyFile('/docs/template.md', '/docs/new-doc.md')
 
 **Parameters:**
 
-**src:** (`string`): Source file path
+**src** (`string`): Source file path
 
-**dest:** (`string`): Destination file path
+**dest** (`string`): Destination file path
 
-**options.overwrite?:** (`boolean`): Overwrite destination if it exists (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite destination if it exists (Default: `true`)
 
 ### `moveFile(src, dest, options?)`
 
@@ -97,11 +97,11 @@ await filesystem.moveFile('/docs/draft.md', '/docs/final.md')
 
 **Parameters:**
 
-**src:** (`string`): Source file path
+**src** (`string`): Source file path
 
-**dest:** (`string`): Destination file path
+**dest** (`string`): Destination file path
 
-**options.overwrite?:** (`boolean`): Overwrite destination if it exists (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite destination if it exists (Default: `true`)
 
 ### `readdir(path, options?)`
 
@@ -135,9 +135,9 @@ await filesystem.mkdir('/deeply/nested/path', { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): Directory path
+**path** (`string`): Directory path
 
-**options.recursive?:** (`boolean`): Create parent directories (Default: `false`)
+**options.recursive** (`boolean`): Create parent directories (Default: `false`)
 
 ### `rmdir(path, options?)`
 
@@ -150,11 +150,11 @@ await filesystem.rmdir('/docs/nested', { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): Directory path
+**path** (`string`): Directory path
 
-**options.recursive?:** (`boolean`): Remove contents recursively (Default: `false`)
+**options.recursive** (`boolean`): Remove contents recursively (Default: `false`)
 
-**options.force?:** (`boolean`): Don't throw if directory doesn't exist (Default: `false`)
+**options.force** (`boolean`): Don't throw if directory doesn't exist (Default: `false`)
 
 ### `exists(path)`
 
@@ -245,7 +245,7 @@ const instructions = filesystem.getInstructions?.()
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/dist/docs/references/reference-workspace-local-filesystem.md

@@ -32,31 +32,31 @@ const response = await agent.generate('List all files in the workspace')
 
 ## Constructor parameters
 
-**basePath:** (`string`): Base directory path on disk. All file paths are resolved relative to this directory.
+**basePath** (`string`): Base directory path on disk. All file paths are resolved relative to this directory.
 
-**id?:** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
 
-**contained?:** (`boolean`): When true, all file operations are restricted to stay within basePath. Prevents path traversal attacks and symlink escapes. See \[containment]\(/docs/workspace/filesystem#containment). (Default: `true`)
+**contained** (`boolean`): When true, all file operations are restricted to stay within basePath. Prevents path traversal attacks and symlink escapes. See \[containment]\(/docs/workspace/filesystem#containment). (Default: `true`)
 
-**allowedPaths?:** (`string[]`): Additional absolute paths that are allowed beyond basePath. Useful with \`contained: true\` to grant access to specific directories without disabling containment entirely. Paths are resolved to absolute paths. (Default: `[]`)
+**allowedPaths** (`string[]`): Additional absolute paths that are allowed beyond basePath. Useful with \`contained: true\` to grant access to specific directories without disabling containment entirely. Paths are resolved to absolute paths. (Default: `[]`)
 
-**instructions?:** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
+**instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
 
-**readOnly?:** (`boolean`): When true, all write operations are blocked. Read operations are still allowed. (Default: `false`)
+**readOnly** (`boolean`): When true, all write operations are blocked. Read operations are still allowed. (Default: `false`)
 
 ## Properties
 
-**id:** (`string`): Filesystem instance identifier
+**id** (`string`): Filesystem instance identifier
 
-**name:** (`string`): Provider name ('LocalFilesystem')
+**name** (`string`): Provider name ('LocalFilesystem')
 
-**provider:** (`string`): Provider identifier ('local')
+**provider** (`string`): Provider identifier ('local')
 
-**basePath:** (`string`): The absolute base path on disk
+**basePath** (`string`): The absolute base path on disk
 
-**readOnly:** (`boolean | undefined`): Whether the filesystem is in read-only mode
+**readOnly** (`boolean | undefined`): Whether the filesystem is in read-only mode
 
-**allowedPaths:** (`readonly string[]`): Current set of additional allowed paths (absolute, resolved). These paths are permitted beyond basePath when containment is enabled.
+**allowedPaths** (`readonly string[]`): Current set of additional allowed paths (absolute, resolved). These paths are permitted beyond basePath when containment is enabled.
 
 ## Methods
 
@@ -101,7 +101,7 @@ filesystem.setAllowedPaths([])
 
 **Parameters:**
 
-**pathsOrUpdater:** (`string[] | ((current: readonly string[]) => string[])`): New allowed paths array or updater function receiving current paths
+**pathsOrUpdater** (`string[] | ((current: readonly string[]) => string[])`): New allowed paths array or updater function receiving current paths
 
 ### `readFile(path, options?)`
 
@@ -114,9 +114,9 @@ const buffer = await filesystem.readFile('/image.png', { encoding: 'binary' })
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**options.encoding?:** (`'utf-8' | 'binary'`): Text or binary encoding (Default: `'utf-8'`)
+**options.encoding** (`'utf-8' | 'binary'`): Text or binary encoding (Default: `'utf-8'`)
 
 ### `writeFile(path, content, options?)`
 
@@ -129,13 +129,13 @@ await filesystem.writeFile('/nested/path/file.md', content, { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**content:** (`string | Buffer`): File content
+**content** (`string | Buffer`): File content
 
-**options.recursive?:** (`boolean`): Create parent directories if they don't exist (Default: `false`)
+**options.recursive** (`boolean`): Create parent directories if they don't exist (Default: `false`)
 
-**options.overwrite?:** (`boolean`): Overwrite existing file (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite existing file (Default: `true`)
 
 ### `appendFile(path, content)`
 
@@ -147,9 +147,9 @@ await filesystem.appendFile('/logs/app.log', 'New log entry\n')
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**content:** (`string | Buffer`): Content to append
+**content** (`string | Buffer`): Content to append
 
 ### `deleteFile(path, options?)`
 
@@ -162,9 +162,9 @@ await filesystem.deleteFile('/docs/maybe.md', { force: true }) // Don't throw if
 
 **Parameters:**
 
-**path:** (`string`): File path
+**path** (`string`): File path
 
-**options.force?:** (`boolean`): Don't throw error if file doesn't exist (Default: `false`)
+**options.force** (`boolean`): Don't throw error if file doesn't exist (Default: `false`)
 
 ### `copyFile(src, dest, options?)`
 
@@ -177,11 +177,11 @@ await filesystem.copyFile('/src/config.json', '/backup/config.json', { overwrite
 
 **Parameters:**
 
-**src:** (`string`): Source file path
+**src** (`string`): Source file path
 
-**dest:** (`string`): Destination file path
+**dest** (`string`): Destination file path
 
-**options.overwrite?:** (`boolean`): Overwrite destination if it exists (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite destination if it exists (Default: `true`)
 
 ### `moveFile(src, dest, options?)`
 
@@ -194,11 +194,11 @@ await filesystem.moveFile('/temp/upload.txt', '/files/document.txt')
 
 **Parameters:**
 
-**src:** (`string`): Source file path
+**src** (`string`): Source file path
 
-**dest:** (`string`): Destination file path
+**dest** (`string`): Destination file path
 
-**options.overwrite?:** (`boolean`): Overwrite destination if it exists (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite destination if it exists (Default: `true`)
 
 ### `mkdir(path, options?)`
 
@@ -211,9 +211,9 @@ await filesystem.mkdir('/deeply/nested/path', { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): Directory path
+**path** (`string`): Directory path
 
-**options.recursive?:** (`boolean`): Create parent directories (Default: `false`)
+**options.recursive** (`boolean`): Create parent directories (Default: `false`)
 
 ### `rmdir(path, options?)`
 
@@ -226,11 +226,11 @@ await filesystem.rmdir('/docs/nested', { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): Directory path
+**path** (`string`): Directory path
 
-**options.recursive?:** (`boolean`): Remove contents recursively (Default: `false`)
+**options.recursive** (`boolean`): Remove contents recursively (Default: `false`)
 
-**options.force?:** (`boolean`): Don't throw if directory doesn't exist (Default: `false`)
+**options.force** (`boolean`): Don't throw if directory doesn't exist (Default: `false`)
 
 ### `readdir(path, options?)`
 
@@ -284,7 +284,7 @@ const instructions = filesystem.getInstructions({ requestContext })
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/dist/docs/references/reference-workspace-local-sandbox.md

@@ -40,47 +40,47 @@ const response = await agent.generate('Run npm install')
 
 ## Constructor parameters
 
-**id?:** (`string`): Unique identifier for this sandbox instance (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for this sandbox instance (Default: `Auto-generated`)
 
-**workingDirectory?:** (`string`): Directory for command execution. Defaults to .sandbox/ in process.cwd() for isolation from seatbelt profiles. (Default: `process.cwd()/.sandbox/`)
+**workingDirectory** (`string`): Directory for command execution. Defaults to .sandbox/ in process.cwd() for isolation from seatbelt profiles. (Default: `process.cwd()/.sandbox/`)
 
-**env?:** (`NodeJS.ProcessEnv`): Environment variables to set. PATH is included by default unless overridden.
+**env** (`NodeJS.ProcessEnv`): Environment variables to set. PATH is included by default unless overridden.
 
-**timeout?:** (`number`): Default timeout for operations in milliseconds (Default: `30000`)
+**timeout** (`number`): Default timeout for operations in milliseconds (Default: `30000`)
 
-**isolation?:** (`'none' | 'seatbelt' | 'bwrap'`): Native OS sandboxing backend. 'seatbelt' for macOS, 'bwrap' for Linux. (Default: `'none'`)
+**isolation** (`'none' | 'seatbelt' | 'bwrap'`): Native OS sandboxing backend. 'seatbelt' for macOS, 'bwrap' for Linux. (Default: `'none'`)
 
-**instructions?:** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
+**instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
 
-**nativeSandbox?:** (`NativeSandboxConfig`): Configuration for native sandboxing (see NativeSandboxConfig below).
+**nativeSandbox** (`NativeSandboxConfig`): Configuration for native sandboxing (see NativeSandboxConfig below).
 
 ## NativeSandboxConfig
 
 Configuration options for native OS sandboxing (used with `isolation: 'seatbelt'` or `'bwrap'`).
 
-**allowNetwork?:** (`boolean`): Allow network access from sandboxed commands. (Default: `false`)
+**allowNetwork** (`boolean`): Allow network access from sandboxed commands. (Default: `false`)
 
-**readOnlyPaths?:** (`string[]`): Additional paths to allow read-only access (system paths are always readable).
+**readOnlyPaths** (`string[]`): Additional paths to allow read-only access (system paths are always readable).
 
-**readWritePaths?:** (`string[]`): Additional paths to allow read-write access beyond the workspace directory.
+**readWritePaths** (`string[]`): Additional paths to allow read-write access beyond the workspace directory.
 
-**seatbeltProfilePath?:** (`string`): Path to a custom seatbelt profile file (macOS only). If the file exists, it's used; if not, a default profile is generated and written to this path.
+**seatbeltProfilePath** (`string`): Path to a custom seatbelt profile file (macOS only). If the file exists, it's used; if not, a default profile is generated and written to this path.
 
-**bwrapArgs?:** (`string[]`): Additional arguments to pass to bwrap (Linux only).
+**bwrapArgs** (`string[]`): Additional arguments to pass to bwrap (Linux only).
 
-**allowSystemBinaries?:** (`boolean`): Allow read access to standard system binary paths (/bin, /usr/bin, etc.). (Default: `true`)
+**allowSystemBinaries** (`boolean`): Allow read access to standard system binary paths (/bin, /usr/bin, etc.). (Default: `true`)
 
 ## Properties
 
-**id:** (`string`): Sandbox instance identifier
+**id** (`string`): Sandbox instance identifier
 
-**name:** (`string`): Provider name ('LocalSandbox')
+**name** (`string`): Provider name ('LocalSandbox')
 
-**provider:** (`string`): Provider identifier ('local')
+**provider** (`string`): Provider identifier ('local')
 
-**status:** (`ProviderStatus`): 'starting' | 'running' | 'stopped' | 'error'
+**status** (`ProviderStatus`): 'starting' | 'running' | 'stopped' | 'error'
 
-**workingDirectory:** (`string`): The configured working directory
+**workingDirectory** (`string`): The configured working directory
 
 ## Methods
 
@@ -135,19 +135,19 @@ const installResult = await sandbox.executeCommand('npm', ['install', 'lodash'],
 
 **Parameters:**
 
-**command:** (`string`): Command to execute
+**command** (`string`): Command to execute
 
-**args?:** (`string[]`): Command arguments
+**args** (`string[]`): Command arguments
 
-**options.timeout?:** (`number`): Execution timeout in milliseconds
+**options.timeout** (`number`): Execution timeout in milliseconds
 
-**options.cwd?:** (`string`): Working directory for the command
+**options.cwd** (`string`): Working directory for the command
 
-**options.env?:** (`Record<string, string>`): Additional environment variables
+**options.env** (`Record<string, string>`): Additional environment variables
 
-**options.onStdout?:** (`(data: string) => void`): Callback for stdout streaming
+**options.onStdout** (`(data: string) => void`): Callback for stdout streaming
 
-**options.onStderr?:** (`(data: string) => void`): Callback for stderr streaming
+**options.onStderr** (`(data: string) => void`): Callback for stderr streaming
 
 ### `getInfo()`
 
@@ -175,7 +175,7 @@ const instructions = sandbox.getInstructions({ requestContext })
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/dist/docs/references/reference-workspace-sandbox.md

@@ -43,19 +43,19 @@ const result = await sandbox.executeCommand('npm', ['install', 'lodash'])
 
 **Parameters:**
 
-**command:** (`string`): Command to execute
+**command** (`string`): Command to execute
 
-**args?:** (`string[]`): Command arguments
+**args** (`string[]`): Command arguments
 
-**options.timeout?:** (`number`): Execution timeout in milliseconds
+**options.timeout** (`number`): Execution timeout in milliseconds
 
-**options.cwd?:** (`string`): Working directory for the command
+**options.cwd** (`string`): Working directory for the command
 
-**options.env?:** (`Record<string, string>`): Additional environment variables
+**options.env** (`Record<string, string>`): Additional environment variables
 
-**options.onStdout?:** (`(data: string) => void`): Callback for stdout streaming
+**options.onStdout** (`(data: string) => void`): Callback for stdout streaming
 
-**options.onStderr?:** (`(data: string) => void`): Callback for stderr streaming
+**options.onStderr** (`(data: string) => void`): Callback for stderr streaming
 
 ### `getInfo()`
 
@@ -77,7 +77,7 @@ const instructions = sandbox.getInstructions?.()
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`