Skip to main content

harness_websearch/
lib.rs

1//! WebSearch tool — Rust port of `@agent-sh/harness-websearch`.
2//!
3//! Conforms to `agent-knowledge/design/websearch.md`. Same contract as the
4//! TS package: declarative web search via a session-configured SearXNG
5//! backend, with tool-layer SSRF defense on the backend URL, a permission
6//! hook, a result-count cap, and a discriminated `ok`/`empty`/`error`
7//! result surface. WebSearch finds; WebFetch reads — there is no HTML
8//! extraction and no spill-to-file (a result list is bounded by `count`).
9
10mod constants;
11mod engine;
12mod engines;
13mod fence;
14mod format;
15mod run;
16mod schema;
17mod ssrf;
18mod types;
19
20pub use constants::*;
21pub use engine::{
22    default_engine, EngineClass, ReqwestEngine, SearchError, SearchErrorCode, WebSearchEngine,
23    WebSearchEngineInput, WebSearchEngineResult,
24};
25pub use engines::{
26    resolve_engine, BraveEngine, EngineBaseUrls, FallbackEngine, MarginaliaEngine, MojeekEngine,
27    ResolvedEngine, TavilyEngine, WikipediaEngine,
28};
29pub use format::{format_empty_text, format_ok_text, render_search_block};
30pub use schema::{
31    safe_parse_websearch_params, WebSearchParams, WebSearchParseError,
32    WEBSEARCH_TOOL_DESCRIPTION, WEBSEARCH_TOOL_NAME,
33};
34pub use ssrf::{classify_host, classify_ip, BlockClass, SsrfDecision};
35pub use types::{
36    SafeSearch, SearchMetadata, WebSearchEmpty, WebSearchError, WebSearchOk,
37    WebSearchPermissionPolicy, WebSearchResult, WebSearchResultItem, WebSearchSessionConfig,
38    WebSearchTimeRange,
39};
40
41pub async fn websearch(
42    params: serde_json::Value,
43    session: &WebSearchSessionConfig,
44) -> WebSearchResult {
45    run::websearch_run(params, session).await
46}