tirea 0.4.0

Rust AI agent framework with typed state, CRDT conflict resolution, and multi-protocol serving
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

//! Prelude for convenient imports.
//!
//! This module re-exports the most commonly used types and traits for
//! tool and plugin development. Using the prelude reduces boilerplate
//! and ensures all extension traits are available.
//!
//! # Example
//!
//! ```ignore
//! use tirea::prelude::*;
//!
//! struct MyTool;
//!
//! #[async_trait]
//! impl Tool for MyTool {
//!     fn descriptor(&self) -> ToolDescriptor {
//!         ToolDescriptor::new("my_tool", "My Tool", "Does something useful")
//!     }
//!
//!     async fn execute(&self, args: Value, ctx: &Thread) -> Result<ToolResult, ToolError> {
//!         // Extension traits are auto-imported (requires "core" feature)
//!         ctx.allow_tool("follow_up");           // PermissionContextExt
//!         ctx.add_reminder("Remember to check"); // ReminderContextExt
//!
//!         Ok(ToolResult::success("my_tool", json!({"status": "done"})))
//!     }
//! }
//! ```

// Re-export async_trait for convenience
pub use async_trait::async_trait;

// Re-export serde_json for tool implementations
pub use serde_json::{json, Value};

// Derive helpers for TypedTool implementations
pub use schemars::JsonSchema;
pub use serde::Deserialize;

// ── Always available: contracts + state ──────────────────────────────────

// Core execution state object (state + runtime metadata + activity wiring)
pub use crate::contracts::Thread;

// Raw state-only context for lower-level integrations
pub use tirea_state::StateContext;

// Tool trait and types
pub use crate::contracts::runtime::tool_call::{
    Tool, ToolDescriptor, ToolError, ToolResult, ToolStatus, TypedTool,
};

// Message types
pub use crate::contracts::thread::{Message, Role, ToolCall};

// Phase types for plugins
pub use crate::contracts::runtime::phase::{
    Phase, RunAction, StepContext, StepOutcome, ToolCallAction,
};
pub use crate::contracts::runtime::tool_call::ToolGate;
pub use crate::contracts::{Suspension, SuspensionResponse};

// ── Core entry points (require "core" feature) ──────────────────────────

#[cfg(feature = "core")]
pub use crate::runtime::{AgentOs, PreparedRun, RunStream};

#[cfg(feature = "core")]
pub use crate::composition::{tool_map, tool_map_from_arc, AgentDefinition, AgentOsBuilder};

// Plugin SPI
pub use crate::contracts::runtime::phase::{ActionSet, BeforeInferenceAction};
pub use crate::contracts::AgentBehavior;

// ── Extension types (require "core" feature) ─────────────────────────────

#[cfg(feature = "core")]
pub use crate::extensions::permission::{
    PermissionAction, PermissionPlugin, ToolPermissionBehavior, ToolPolicyPlugin,
};

#[cfg(feature = "core")]
pub use crate::extensions::reminder::{
    add_reminder_action, clear_reminder_action, inject_reminders, ReminderAction, ReminderPlugin,
    SystemReminder,
};

// ── Skills extension (require "skills" feature) ──────────────────────────

#[cfg(feature = "skills")]
pub use crate::skills::{SkillDiscoveryPlugin, SkillRegistry, SkillSubsystem};