oxi-sdk 0.25.8

oxi AI agent SDK — build isolated, multi-agent AI systems
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

//! Tool factories for common tool sets

use std::path::Path;
use std::sync::Arc;

use oxi_agent::{
    tools::browse::{BrowseConfig, BrowseExtractTool, BrowseTool, BrowserEngine},
    tools::{EditTool, LsTool, ReadTool, WriteTool},
    ToolRegistry,
};

/// Create the standard coding tools: read, write, edit, ls
pub fn coding_tools(cwd: &Path) -> Arc<ToolRegistry> {
    let registry = ToolRegistry::new();
    registry.register(ReadTool::with_cwd(cwd.to_path_buf()));
    registry.register(WriteTool::with_cwd(cwd.to_path_buf()));
    registry.register(EditTool::with_cwd(cwd.to_path_buf()));
    registry.register(LsTool::with_cwd(cwd.to_path_buf()));
    Arc::new(registry)
}

/// Create read-only tools: read, ls
pub fn readonly_tools(cwd: &Path) -> Arc<ToolRegistry> {
    let registry = ToolRegistry::new();
    registry.register(ReadTool::with_cwd(cwd.to_path_buf()));
    registry.register(LsTool::with_cwd(cwd.to_path_buf()));
    Arc::new(registry)
}

/// Create browser tools: browse, browse_extract.
///
/// Requires a [`BrowserEngine`] implementation. Use `native_browser_tools()`
/// when the `native-browser` feature is enabled.
///
/// # Example
///
/// ```ignore
/// // Requires a BrowserEngine implementation
/// use oxi_sdk::browsing_tools;
/// let engine: Arc<dyn BrowserEngine> = /* ... */;
/// let tools = browsing_tools(engine);
/// ```
pub fn browsing_tools(engine: Arc<dyn BrowserEngine>) -> Arc<ToolRegistry> {
    let registry = ToolRegistry::new();
    registry.register(BrowseTool::new(Arc::clone(&engine)));
    registry.register(BrowseExtractTool::new(engine));
    Arc::new(registry)
}

/// Create browser tools with custom configuration.
///
/// Like [`browsing_tools()`] but accepts a [`BrowseConfig`] for tuning
/// timeouts, cache, concurrency limits, etc.
pub fn browsing_tools_with_config(
    engine: Arc<dyn BrowserEngine>,
    config: BrowseConfig,
) -> Arc<ToolRegistry> {
    let registry = ToolRegistry::new();
    registry.register(BrowseTool::with_config(Arc::clone(&engine), config.clone()));
    registry.register(BrowseExtractTool::with_config(engine, config));
    Arc::new(registry)
}

/// Create the full toolset: coding + browser + browse_extract.
///
/// Convenience function that combines [`coding_tools()`] and browser tools
/// into a single registry. The `cwd` is used for file tools, and the
/// `engine` is used for browser tools.
///
/// # Example
///
/// ```ignore
/// // Requires a BrowserEngine implementation
/// use oxi_sdk::full_tools;
/// let engine: Arc<dyn BrowserEngine> = /* ... */;
/// let tools = full_tools(Path::new("/workspace"), engine);
/// ```
pub fn full_tools(cwd: &Path, engine: Arc<dyn BrowserEngine>) -> Arc<ToolRegistry> {
    let registry = ToolRegistry::new();
    // Coding tools
    registry.register(ReadTool::with_cwd(cwd.to_path_buf()));
    registry.register(WriteTool::with_cwd(cwd.to_path_buf()));
    registry.register(EditTool::with_cwd(cwd.to_path_buf()));
    registry.register(LsTool::with_cwd(cwd.to_path_buf()));
    // Browser tools
    registry.register(BrowseTool::new(Arc::clone(&engine)));
    registry.register(BrowseExtractTool::new(engine));
    Arc::new(registry)
}

/// Create browser tools using the native oxibrowser-core backend.
///
/// Only available when the `native-browser` feature is enabled on
/// `oxi-agent`. Returns an error if the browser engine fails to initialize.
///
/// # Example
///
/// ```ignore
/// // Requires native-browser feature
/// let tools = native_browser_tools().expect("browser init failed");
/// ```
#[cfg(feature = "native-browser")]
#[cfg_attr(docsrs, doc(cfg(feature = "native-browser")))]
pub async fn native_browser_tools() -> anyhow::Result<Arc<ToolRegistry>> {
    let engine = oxi_agent::tools::browse::OxiBrowserEngine::new().await?;
    Ok(browsing_tools(Arc::new(engine)))
}

/// Create browser tools using the native backend with custom config.
#[cfg(feature = "native-browser")]
#[cfg_attr(docsrs, doc(cfg(feature = "native-browser")))]
pub async fn native_browser_tools_with_config(
    config: BrowseConfig,
) -> anyhow::Result<Arc<ToolRegistry>> {
    let engine = oxi_agent::tools::browse::OxiBrowserEngine::with_config(config.clone()).await?;
    Ok(browsing_tools_with_config(Arc::new(engine), config))
}

/// Create all browser tools including session support.
///
/// Registers `browse`, `browse_extract`, `browse_script`, and `browse_session`.
/// Only available when the `native-browser` feature is enabled.
#[cfg(feature = "native-browser")]
#[cfg_attr(docsrs, doc(cfg(feature = "native-browser")))]
pub fn browsing_tools_with_session(engine: Arc<dyn BrowserEngine>) -> Arc<ToolRegistry> {
    use oxi_agent::tools::browse::{BrowseScriptTool, BrowseSessionTool};

    let registry = ToolRegistry::new();
    registry.register(BrowseTool::new(Arc::clone(&engine)));
    registry.register(BrowseExtractTool::new(Arc::clone(&engine)));
    registry.register(BrowseScriptTool::new(Arc::clone(&engine)));
    registry.register(BrowseSessionTool::new(engine));
    Arc::new(registry)
}