Struct Plan 

pub struct Plan {
    pub version: u32,
    pub cwd: Option<String>,
    pub write_policy: Option<WritePolicyOverride>,
    pub strict: Option<bool>,
    pub operations: Vec<Operation>,
    pub format: Option<Vec<FormatStep>>,
    pub validate: Option<Vec<ValidationStep>>,
    pub verify: Option<Vec<VerifyCheck>>,
    pub for_each: Option<ForEach>,
}

A transaction plan containing multiple operations to execute atomically.

Fields

version: u32

Schema version. Defaults to 1 when omitted.

cwd: Option<String>

Optional re-root for relative operation paths and lifecycle steps.

Relative values resolve from the invocation / MCP server workspace root (not from the plan file location). Example: "fixtures/complex" with op path "config.json" targets fixtures/complex/config.json.

On MCP, use a relative path that stays inside the server workspace; absolute path strings and ../ escapes are rejected. Do not combine with for_each on any surface (glob expansion uses the invocation cwd; combining with plan.cwd double-prefixes {path}). Use workspace-relative {path} templates without cwd instead. CLI and library callers may use absolute paths when PathGuard policy allows them (still without for_each).

write_policy: Option<WritePolicyOverride>

strict: Option<bool>

When omitted from the plan, defaults to strict mode at execution time.

operations: Vec<Operation>

Operations to run. Accepts alias ops (common agent shorthand).

format: Option<Vec<FormatStep>>

validate: Option<Vec<ValidationStep>>

verify: Option<Vec<VerifyCheck>>

Pre/post-operation symbol verification checks.

for_each: Option<ForEach>

Glob-driven batch: expand operations once per matching file.

Implementations

impl Plan

pub fn has_lifecycle_steps(&self) -> bool

Returns true if the plan has any format or validate steps that could modify files outside the transaction scope.

Trait Implementations

impl Debug for Plan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Plan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Plan

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 Plan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.