tirea-contract 0.5.0

Agent runtime contracts: 8-phase plugin lifecycle, typed tool traits, and state scope system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use crate::runtime::tool_call::{PendingToolCall, Suspension, ToolCallResumeMode, ToolResult};
use crate::thread::ToolCall;
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Tool-gate extension: per-tool-call execution control.
///
/// Populated by `BlockTool`, `AllowTool`, `SuspendTool`,
/// `OverrideToolResult` actions during `BeforeToolExecute`.
#[derive(Debug, Clone)]
pub struct ToolGate {
    /// Tool call ID.
    pub id: String,
    /// Tool name.
    pub name: String,
    /// Tool arguments.
    pub args: Value,
    /// Tool execution result (set after execution or by override).
    pub result: Option<ToolResult>,
    /// Whether execution is blocked.
    pub blocked: bool,
    /// Block reason.
    pub block_reason: Option<String>,
    /// Whether execution is pending user confirmation.
    pub pending: bool,
    /// Canonical suspend ticket carrying pause payload.
    pub suspend_ticket: Option<SuspendTicket>,
}

impl ToolGate {
    /// Create a new tool gate from identifiers and arguments.
    pub fn new(id: impl Into<String>, name: impl Into<String>, args: Value) -> Self {
        Self {
            id: id.into(),
            name: name.into(),
            args,
            result: None,
            blocked: false,
            block_reason: None,
            pending: false,
            suspend_ticket: None,
        }
    }

    /// Create from a `ToolCall`.
    pub fn from_tool_call(call: &ToolCall) -> Self {
        Self::new(&call.id, &call.name, call.arguments.clone())
    }

    /// Check if the tool execution is blocked.
    pub fn is_blocked(&self) -> bool {
        self.blocked
    }

    /// Check if the tool execution is pending.
    pub fn is_pending(&self) -> bool {
        self.pending
    }

    /// Stable idempotency key for this tool invocation.
    pub fn idempotency_key(&self) -> &str {
        &self.id
    }
}

/// Suspension payload for `ToolCallAction::Suspend`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SuspendTicket {
    /// External suspension payload.
    #[serde(default)]
    pub suspension: Suspension,
    /// Pending call projection emitted to event stream.
    #[serde(default)]
    pub pending: PendingToolCall,
    /// Resume mapping strategy.
    #[serde(default)]
    pub resume_mode: ToolCallResumeMode,
}

impl SuspendTicket {
    pub fn new(
        suspension: Suspension,
        pending: PendingToolCall,
        resume_mode: ToolCallResumeMode,
    ) -> Self {
        Self {
            suspension,
            pending,
            resume_mode,
        }
    }

    pub fn use_decision_as_tool_result(suspension: Suspension, pending: PendingToolCall) -> Self {
        Self::new(
            suspension,
            pending,
            ToolCallResumeMode::UseDecisionAsToolResult,
        )
    }

    pub fn with_resume_mode(mut self, resume_mode: ToolCallResumeMode) -> Self {
        self.resume_mode = resume_mode;
        self
    }

    pub fn with_pending(mut self, pending: PendingToolCall) -> Self {
        self.pending = pending;
        self
    }
}

/// Tool-call level control action emitted by plugins.
#[derive(Debug, Clone, PartialEq)]
pub enum ToolCallAction {
    Proceed,
    Suspend(Box<SuspendTicket>),
    Block { reason: String },
}

impl ToolCallAction {
    pub fn suspend(ticket: SuspendTicket) -> Self {
        Self::Suspend(Box::new(ticket))
    }
}