Struct Initialize 

pub struct Initialize {
    pub init_type: InitializeType,
    pub any_workspace_path: String,
    pub initial_files_to_read: Vec<String>,
    pub task_id_to_resume: String,
    pub mode_name: ModeName,
    pub thread_id: String,
    pub code_writer_config: Option<CodeWriterConfig>,
}

Parameters for initializing the shell environment

This struct represents the parameters needed to initialize or update the shell environment. It is used by the Initialize tool, which must be called before any other shell tools.

Fields

init_type: InitializeType

Initialization type, indicating the purpose of the call

• FirstCall: Initial setup for a new conversation
• UserAskedModeChange: User requested to change the mode during a conversation
• ResetShell: Reset the shell if it’s not working properly
• UserAskedChangeWorkspace: User requested to change the workspace during a conversation

any_workspace_path: String

Path to the workspace directory or file

This can be an absolute path or a path relative to the current directory. If it’s a file, the parent directory will be used as the workspace. If it doesn’t exist and is an absolute path, it will be created. If it’s a relative path and doesn’t exist, an error will be returned.

initial_files_to_read: Vec<String>

List of files to read initially

These files can be absolute paths or paths relative to the workspace. They will be read and their contents provided in the response.

task_id_to_resume: String

ID of a task to resume

If provided during a first_call, the task with this ID will be resumed. This allows continuing a conversation from a previous session.

mode_name: ModeName

Mode name for the shell environment

• wcgw: Full permissions (default)
• architect: Restricted permissions, read-only
• code_writer: Custom permissions for code writing

thread_id: String

ID of the thread session

If not provided for a first_call, a new ID will be generated. This ID must be included in all subsequent tool calls.

code_writer_config: Option<CodeWriterConfig>

Configuration for code_writer mode

Only used when mode_name is “code_writer”. Specifies allowed commands and file globs for writing/editing.

Trait Implementations

impl Clone for Initialize

fn clone(&self) -> Initialize

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Initialize

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Initialize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Initialize

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Initialize

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.