Struct ToolEnvelope 

pub struct ToolEnvelope {
    pub exit_code: Option<i32>,
    pub stdout: Option<String>,
    pub stderr: Option<String>,
    pub timed_out: Option<bool>,
    pub stdout_truncated: bool,
    pub stderr_truncated: bool,
    pub denied: bool,
    pub denials: Vec<Denial>,
    pub sandbox_kind: SandboxKind,
    pub enforcement: EnforcementReport,
    pub disclosure: Disclosure,
}

A structured execution result. Serialized to the MCP content shape via ToolEnvelope::into_json; absent fields are omitted.

Fields

exit_code: Option<i32>

Process exit code, when the operation had one.

stdout: Option<String>

Captured standard output, when relevant.

stderr: Option<String>

Captured standard error, when relevant.

timed_out: Option<bool>

Whether the operation was cut short by a timeout.

stdout_truncated: bool

Whether captured stdout was clipped at the output cap (more was produced than was kept). Lets a consumer tell a complete result from a truncated one. Omitted (treated as false) when output was not clipped.

stderr_truncated: bool

Whether captured stderr was clipped at the output cap. Omitted when not.

denied: bool

Whether the in-process leash recorded at least one denial during this invocation. This is a structured signal: it is set iff Self::denials is non-empty, so a consumer never has to string-match stderr to detect a security refusal. Omitted (treated as false) when no denial was recorded.

denials: Vec<Denial>

The denials the interceptor recorded, in the order they occurred. Empty (and omitted from JSON) unless Self::denied is true.

sandbox_kind: SandboxKind

The OS-level sandbox in force when this ran. Always present so callers can tell whether the leash was kernel-enforced or advisory.

enforcement: EnforcementReport

Per-axis confinement report (ADR 0004 D1): for each restricted axis, whether it is kernel / interceptor / advisory. Refines the coarse sandbox_kind (which stays the minimum claim) at axis grain. Omitted from JSON when no axis is restricted.

disclosure: Disclosure

Operator-facing disclosure (ADR 0017 D6) — informational only, never part of the enforcement claim. Quiet by default (omitted when nothing is worth disclosing); an unbridled run always surfaces here.

Implementations

impl ToolEnvelope

pub fn new(sandbox_kind: SandboxKind) -> ToolEnvelope

An envelope stamped with the sandbox kind and nothing else set.

pub fn with_exit_code(self, code: i32) -> ToolEnvelope

Set the exit code (builder style).

pub fn with_stdout(self, stdout: impl Into<String>) -> ToolEnvelope

Set captured stdout (builder style).

pub fn with_stderr(self, stderr: impl Into<String>) -> ToolEnvelope

Set captured stderr (builder style).

pub fn with_timed_out(self, timed_out: bool) -> ToolEnvelope

Mark whether the operation timed out (builder style).

pub fn with_truncation( self, stdout_truncated: bool, stderr_truncated: bool, ) -> ToolEnvelope

Mark whether captured stdout/stderr were clipped at the cap (builder style). A truncated stream is a bounded read: peak buffering never exceeds the cap regardless of how much the child produced.

pub fn with_denials(self, denials: Vec<Denial>) -> ToolEnvelope

Attach the leash denials the interceptor recorded (builder style).

Self::denied is set to true iff denials is non-empty, so the boolean flag and the list can never disagree. Passing an empty vec is a no-op (the result stays un-denied), which keeps the common nothing-was-denied path clean.

pub fn with_enforcement(self, enforcement: EnforcementReport) -> ToolEnvelope

Attach the per-axis confinement report (builder style; ADR 0004 D1).

pub fn with_disclosure(self, disclosure: Disclosure) -> ToolEnvelope

Attach the operator-facing disclosure (builder style; ADR 0017 D6). Purely informational — it does not affect Self::enforcement, Self::sandbox_kind, or any confinement claim.

pub fn into_json(self) -> Value

Serialize to the JSON content shape tools return.

Panics

Never in practice: the envelope contains only JSON-representable scalars.

Trait Implementations

impl Clone for ToolEnvelope

fn clone(&self) -> ToolEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolEnvelope

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

Formats the value using the given formatter.

impl Default for ToolEnvelope

fn default() -> ToolEnvelope

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolEnvelope

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolEnvelope, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.