Skip to content

AgentWorkspaceDefinition

type AgentWorkspaceDefinition =
| FileSystem
| {
fs: FileSystem;
instructions?: string;
modelWritable?: boolean;
readOnly?: boolean;
shell?: Shell;
};

FileSystem


{
fs: FileSystem;
instructions?: string;
modelWritable?: boolean;
readOnly?: boolean;
shell?: Shell;
}
fs: FileSystem;
optional instructions?: string;

Model-facing path and mount guidance appended to the workspace tool description.

optional modelWritable?: boolean;

Expose workspace mutation operations to the model. Defaults false even when executor code may write.

optional readOnly?: boolean;
optional shell?: Shell;