mofa-foundation 0.1.1

MoFA Foundation - Core building blocks and utilities
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
//! 工具适配器
//!
//! 提供便捷的工具创建方式

use async_trait::async_trait;
use mofa_kernel::agent::Tool;
use mofa_kernel::agent::components::tool::{ToolInput, ToolMetadata, ToolResult};
use mofa_kernel::agent::context::AgentContext;
use std::future::Future;
use std::pin::Pin;

/// 函数工具
///
/// 从函数创建工具
///
/// # 示例
///
/// ```rust,ignore
/// use mofa_foundation::agent::tools::FunctionTool;
///
/// async fn my_tool_fn(input: ToolInput, ctx: &AgentContext) -> ToolResult {
///     let message = input.get_str("message").unwrap_or("default");
///     ToolResult::success_text(format!("Processed: {}", message))
/// }
///
/// let tool = FunctionTool::new(
///     "my_tool",
///     "A custom tool",
///     serde_json::json!({
///         "type": "object",
///         "properties": {
///             "message": { "type": "string" }
///         }
///     }),
///     my_tool_fn,
/// );
/// ```
pub struct FunctionTool<F>
where
    F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>>
        + Send
        + Sync,
{
    name: String,
    description: String,
    parameters_schema: serde_json::Value,
    handler: F,
    metadata: ToolMetadata,
}

impl<F> FunctionTool<F>
where
    F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>>
        + Send
        + Sync,
{
    /// 创建新的函数工具
    pub fn new(
        name: impl Into<String>,
        description: impl Into<String>,
        parameters_schema: serde_json::Value,
        handler: F,
    ) -> Self {
        Self {
            name: name.into(),
            description: description.into(),
            parameters_schema,
            handler,
            metadata: ToolMetadata::default(),
        }
    }

    /// 设置元数据
    pub fn with_metadata(mut self, metadata: ToolMetadata) -> Self {
        self.metadata = metadata;
        self
    }
}

#[async_trait]
impl<F> Tool for FunctionTool<F>
where
    F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>>
        + Send
        + Sync,
{
    fn name(&self) -> &str {
        &self.name
    }

    fn description(&self) -> &str {
        &self.description
    }

    fn parameters_schema(&self) -> serde_json::Value {
        self.parameters_schema.clone()
    }

    async fn execute(&self, input: ToolInput, ctx: &AgentContext) -> ToolResult {
        (self.handler)(input, ctx).await
    }

    fn metadata(&self) -> ToolMetadata {
        self.metadata.clone()
    }
}

/// 闭包工具
///
/// 使用闭包创建简单工具
///
/// # 示例
///
/// ```rust,ignore
/// use mofa_foundation::agent::tools::ClosureTool;
///
/// let tool = ClosureTool::new(
///     "add",
///     "Add two numbers",
///     |input| {
///         let a = input.get_number("a").unwrap_or(0.0);
///         let b = input.get_number("b").unwrap_or(0.0);
///         ToolResult::success_text(format!("{}", a + b))
///     },
/// );
/// ```
pub struct ClosureTool<F>
where
    F: Fn(ToolInput) -> ToolResult + Send + Sync,
{
    name: String,
    description: String,
    parameters_schema: serde_json::Value,
    handler: F,
    metadata: ToolMetadata,
}

impl<F> ClosureTool<F>
where
    F: Fn(ToolInput) -> ToolResult + Send + Sync,
{
    /// 创建新的闭包工具
    pub fn new(name: impl Into<String>, description: impl Into<String>, handler: F) -> Self {
        Self {
            name: name.into(),
            description: description.into(),
            parameters_schema: serde_json::json!({
                "type": "object",
                "properties": {}
            }),
            handler,
            metadata: ToolMetadata::default(),
        }
    }

    /// 设置参数 Schema
    pub fn with_schema(mut self, schema: serde_json::Value) -> Self {
        self.parameters_schema = schema;
        self
    }

    /// 设置元数据
    pub fn with_metadata(mut self, metadata: ToolMetadata) -> Self {
        self.metadata = metadata;
        self
    }
}

#[async_trait]
impl<F> Tool for ClosureTool<F>
where
    F: Fn(ToolInput) -> ToolResult + Send + Sync,
{
    fn name(&self) -> &str {
        &self.name
    }

    fn description(&self) -> &str {
        &self.description
    }

    fn parameters_schema(&self) -> serde_json::Value {
        self.parameters_schema.clone()
    }

    async fn execute(&self, input: ToolInput, _ctx: &AgentContext) -> ToolResult {
        (self.handler)(input)
    }

    fn metadata(&self) -> ToolMetadata {
        self.metadata.clone()
    }
}

// ============================================================================
// 便捷工具创建宏
// ============================================================================

/// 创建简单同步工具
#[macro_export]
macro_rules! simple_tool {
    ($name:expr, $desc:expr, $handler:expr) => {
        $crate::agent::tools::ClosureTool::new($name, $desc, $handler)
    };
    ($name:expr, $desc:expr, $schema:expr, $handler:expr) => {
        $crate::agent::tools::ClosureTool::new($name, $desc, $handler).with_schema($schema)
    };
}

// ============================================================================
// 内置工具集合
// ============================================================================

/// 内置工具集合
pub struct BuiltinTools;

impl BuiltinTools {
    /// 创建计算器工具
    pub fn calculator() -> impl Tool {
        ClosureTool::new(
            "calculator",
            "Perform basic arithmetic operations",
            |input| {
                let operation = input.get_str("operation").unwrap_or("add");
                let a = input.get_number("a").unwrap_or(0.0);
                let b = input.get_number("b").unwrap_or(0.0);

                let result = match operation {
                    "add" => a + b,
                    "sub" => a - b,
                    "mul" => a * b,
                    "div" => {
                        if b == 0.0 {
                            return ToolResult::failure("Division by zero");
                        }
                        a / b
                    }
                    _ => return ToolResult::failure(format!("Unknown operation: {}", operation)),
                };

                ToolResult::success_text(format!("{}", result))
            },
        )
        .with_schema(serde_json::json!({
            "type": "object",
            "properties": {
                "operation": {
                    "type": "string",
                    "enum": ["add", "sub", "mul", "div"],
                    "description": "The arithmetic operation to perform"
                },
                "a": {
                    "type": "number",
                    "description": "First operand"
                },
                "b": {
                    "type": "number",
                    "description": "Second operand"
                }
            },
            "required": ["operation", "a", "b"]
        }))
    }

    /// 创建当前时间工具
    pub fn current_time() -> impl Tool {
        ClosureTool::new("current_time", "Get the current date and time", |_input| {
            let now = std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap_or_default()
                .as_secs();

            ToolResult::success(serde_json::json!({
                "timestamp": now,
                "formatted": format!("Unix timestamp: {}", now)
            }))
        })
    }

    /// 创建 JSON 解析工具
    pub fn json_parser() -> impl Tool {
        ClosureTool::new(
            "json_parser",
            "Parse JSON string into structured data",
            |input| {
                let json_str = match input.get_str("json") {
                    Some(s) => s,
                    None => return ToolResult::failure("No JSON string provided"),
                };

                match serde_json::from_str::<serde_json::Value>(json_str) {
                    Ok(parsed) => ToolResult::success(parsed),
                    Err(e) => ToolResult::failure(format!("Failed to parse JSON: {}", e)),
                }
            },
        )
        .with_schema(serde_json::json!({
            "type": "object",
            "properties": {
                "json": {
                    "type": "string",
                    "description": "The JSON string to parse"
                }
            },
            "required": ["json"]
        }))
    }

    /// 创建字符串处理工具
    pub fn string_utils() -> impl Tool {
        ClosureTool::new("string_utils", "String manipulation utilities", |input| {
            let operation = input.get_str("operation").unwrap_or("length");
            let text = input.get_str("text").unwrap_or("");

            let result = match operation {
                "length" => serde_json::json!({ "length": text.len() }),
                "upper" => serde_json::json!({ "result": text.to_uppercase() }),
                "lower" => serde_json::json!({ "result": text.to_lowercase() }),
                "trim" => serde_json::json!({ "result": text.trim() }),
                "reverse" => {
                    serde_json::json!({ "result": text.chars().rev().collect::<String>() })
                }
                "word_count" => serde_json::json!({ "count": text.split_whitespace().count() }),
                _ => return ToolResult::failure(format!("Unknown operation: {}", operation)),
            };

            ToolResult::success(result)
        })
        .with_schema(serde_json::json!({
            "type": "object",
            "properties": {
                "operation": {
                    "type": "string",
                    "enum": ["length", "upper", "lower", "trim", "reverse", "word_count"],
                    "description": "The string operation to perform"
                },
                "text": {
                    "type": "string",
                    "description": "The text to process"
                }
            },
            "required": ["operation", "text"]
        }))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_closure_tool() {
        let tool = ClosureTool::new("test", "Test tool", |input| {
            let msg = input.get_str("message").unwrap_or("default");
            ToolResult::success_text(format!("Got: {}", msg))
        });

        let ctx = AgentContext::new("test");
        let input = ToolInput::from_json(serde_json::json!({"message": "hello"}));

        let result = tool.execute(input, &ctx).await;
        assert!(result.success);
        assert_eq!(result.as_text(), Some("Got: hello"));
    }

    #[tokio::test]
    async fn test_calculator_tool() {
        let tool = BuiltinTools::calculator();
        let ctx = AgentContext::new("test");

        // Test addition
        let input = ToolInput::from_json(serde_json::json!({
            "operation": "add",
            "a": 5,
            "b": 3
        }));
        let result = tool.execute(input, &ctx).await;
        assert!(result.success);
        assert_eq!(result.as_text(), Some("8"));

        // Test division by zero
        let input = ToolInput::from_json(serde_json::json!({
            "operation": "div",
            "a": 10,
            "b": 0
        }));
        let result = tool.execute(input, &ctx).await;
        assert!(!result.success);
    }

    #[tokio::test]
    async fn test_string_utils_tool() {
        let tool = BuiltinTools::string_utils();
        let ctx = AgentContext::new("test");

        let input = ToolInput::from_json(serde_json::json!({
            "operation": "upper",
            "text": "hello world"
        }));
        let result = tool.execute(input, &ctx).await;
        assert!(result.success);

        let output = result.output;
        assert_eq!(output["result"], "HELLO WORLD");
    }
}