agentool 0.2.0

Rust toolkit for AI agents: JSON Schema-defined tools for workspace files, search, web, Markdown, Git, memory, human-in-the-loop hooks, and todos.
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

//! Human-in-the-loop tools: [`interact_ask`](InteractAskTool), [`interact_confirm`](InteractConfirmTool), [`interact_notify`](InteractNotifyTool).
//!
//! Actual I/O is provided by [`InteractBackend`]; use [`InteractContext::unsupported`] only when
//! you will not call `interact_ask` / `interact_confirm`, or inject [`StubInteractBackend`](backends::StubInteractBackend) for tests.

mod backend;
mod backends;
mod error;
mod ops;
mod tools;

use std::sync::Arc;

pub use backend::{InteractBackend, NotifyLevel, UnsupportedInteractBackend};
pub use backends::StubInteractBackend;
pub use tools::{all_tools, InteractAskTool, InteractConfirmTool, InteractNotifyTool};

/// Holds the [`InteractBackend`] used by all interact tools.
#[derive(Clone)]
pub struct InteractContext {
    pub backend: Arc<dyn InteractBackend>,
}

impl InteractContext {
    pub fn new(backend: Arc<dyn InteractBackend>) -> Self {
        Self { backend }
    }

    /// [`UnsupportedInteractBackend`]: `interact_ask` / `interact_confirm` error; `interact_notify` returns `sent: false`.
    pub fn unsupported() -> Self {
        Self {
            backend: Arc::new(UnsupportedInteractBackend),
        }
    }
}

impl std::fmt::Debug for InteractContext {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("InteractContext")
            .field("backend", &"<dyn InteractBackend>")
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use serde_json::json;

    use super::*;

    #[tokio::test]
    async fn unsupported_ask_and_confirm_err_notify_false() {
        let ctx = Arc::new(InteractContext::unsupported());
        let tools = all_tools(ctx);

        let ask = tools.iter().find(|t| t.name() == "interact_ask").unwrap();
        let e = ask.execute(json!({ "question": "hi?" })).await.unwrap_err();
        assert_eq!(e.code, "INTERACT_NOT_SUPPORTED");

        let confirm = tools
            .iter()
            .find(|t| t.name() == "interact_confirm")
            .unwrap();
        let e2 = confirm
            .execute(json!({ "message": "sure?" }))
            .await
            .unwrap_err();
        assert_eq!(e2.code, "INTERACT_NOT_SUPPORTED");

        let notify = tools
            .iter()
            .find(|t| t.name() == "interact_notify")
            .unwrap();
        let n = notify
            .execute(json!({ "message": "ping", "level": "warning" }))
            .await
            .unwrap();
        assert_eq!(n["data"]["sent"], false);
    }

    #[tokio::test]
    async fn stub_backend_roundtrip() {
        let ctx = Arc::new(InteractContext::new(Arc::new(StubInteractBackend {
            answer: "blue".into(),
            confirmed: false,
            notify_sent: true,
        })));
        let tools = all_tools(ctx);

        let ask = tools.iter().find(|t| t.name() == "interact_ask").unwrap();
        let a = ask.execute(json!({ "question": "color?" })).await.unwrap();
        assert_eq!(a["data"]["answer"], "blue");

        let confirm = tools
            .iter()
            .find(|t| t.name() == "interact_confirm")
            .unwrap();
        let c = confirm.execute(json!({ "message": "go?" })).await.unwrap();
        assert_eq!(c["data"]["confirmed"], false);

        let notify = tools
            .iter()
            .find(|t| t.name() == "interact_notify")
            .unwrap();
        let n = notify.execute(json!({ "message": "done" })).await.unwrap();
        assert_eq!(n["data"]["sent"], true);
    }

    #[tokio::test]
    async fn invalid_notify_level() {
        let ctx = Arc::new(InteractContext::unsupported());
        let notify = all_tools(ctx)
            .into_iter()
            .find(|t| t.name() == "interact_notify")
            .unwrap();
        let e = notify
            .execute(json!({ "message": "x", "level": "loud" }))
            .await
            .unwrap_err();
        assert_eq!(e.code, "INTERACT_INVALID_PARAM");
    }
}