ferrin-tool 0.2.0

Ferrin tool system: tool definitions, tool sets, approval, repair, fingerprints, sandbox trait.
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

//! Ferrin tool system.
//!
//! Tool definitions ([`Tool`], [`ToolKind`], [`ToolSet`]), the execution
//! contract ([`ToolExecute`], [`ToolOutput`], [`ToolContext`], [`ToolError`]),
//! approval declarations ([`NeedsApproval`]), model-output normalisation,
//! caller restrictions, tool fingerprints and (feature `sandbox`) the
//! [`Sandbox`] trait with a local-process implementation.
//!
//! Tool call parsing, approval resolution, execution scheduling and repair
//! live in the core crate; this crate only describes tools and runs one
//! execution when asked.
//!
//! Design: `docs/01-architecture/06-tool-system.md`, ADR 0012.
//!
//! # Attribution
//!
//! Portions of this crate are derived from the Vercel AI SDK (Apache-2.0,
//! Copyright 2023 Vercel, Inc.), translated from TypeScript to Rust and
//! modified. See the `NOTICE` file in the crate root.

mod builder;
pub mod callers;
mod error;
mod execute;
pub mod fingerprint;
pub mod model_output;
#[cfg(feature = "sandbox")]
pub mod sandbox;
mod set;
mod tool;

pub use builder::ToolBuilder;
pub use callers::PreparedToolCallers;
pub use callers::ToolCaller;
pub use callers::ToolCallerDefinition;
pub use callers::ToolCallers;
pub use error::DuplicateToolError;
pub use error::ToolError;
pub use execute::ToolContext;
pub use execute::ToolExecute;
pub use execute::ToolOutput;
pub use execute::ToolOutputStream;
pub use execute::execute_to_completion;
pub use ferrin_schema::JsonSchema;
pub use ferrin_schema::Schema;
pub use fingerprint::ToolDrift;
pub use model_output::ErrorMode;
#[cfg(feature = "sandbox")]
pub use sandbox::LocalProcessSandbox;
#[cfg(feature = "sandbox")]
pub use sandbox::Sandbox;
#[cfg(feature = "sandbox")]
pub use sandbox::SandboxProcess;
pub use set::ToolSet;
pub use tool::ApprovalFn;
pub use tool::Description;
pub use tool::DescriptionContext;
pub use tool::DescriptionFn;
pub use tool::InputAvailableHook;
pub use tool::InputDeltaHook;
pub use tool::InputStartHook;
pub use tool::ModelOutputArgs;
pub use tool::NeedsApproval;
pub use tool::ToModelOutputFn;
pub use tool::Tool;
pub use tool::ToolHooks;
pub use tool::ToolKind;