agentool 0.1.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

# Web (`web`)

[中文](README.zh.md) | English

[← Back to repository overview](../../README.md)

Sources: [mod.rs](mod.rs), [backend.rs](backend.rs), [types.rs](types.rs), [backends/](backends/), [ops.rs](ops.rs), [tools.rs](tools.rs)

**`WebContext` and pluggable backends**

- `WebContext::new()?`: default `reqwest::Client` (~30s timeout, 15s connect, up to 8 redirects, `agentool` User-Agent) + [`DuckDuckGoSearchBackend`](backends/duckduckgo.rs) + [`DirectFetchBackend`](backends/direct_fetch.rs).
- `WebContext::with_client(client)`: swap the HTTP client only; backends stay default.
- `WebContextBuilder`: combine `.client(...)`, `.search(...)` / `.search_backend(Arc<dyn WebSearchBackend>)`, `.fetch(...)` / `.fetch_backend(Arc<dyn WebFetchBackend>)`; or `WebContext::from_parts(client, search, fetch)`.
- Implement [`WebSearchBackend`](backend.rs) / [`WebFetchBackend`](backend.rs) returning [`WebSearchResult`](types.rs) / [`WebFetchResult`](types.rs); errors are [`ToolError`](../tool.rs) (often `NETWORK_ERROR`).

Custom search example:

```rust
use std::sync::Arc;
use async_trait::async_trait;
use reqwest::Client;
use agentool::web::{WebContextBuilder, WebSearchBackend, WebSearchResult, all_tools};
use agentool::ToolError;

struct MySearch;

#[async_trait]
impl WebSearchBackend for MySearch {
    async fn search(
        &self,
        _client: &Client,
        query: &str,
        limit: usize,
    ) -> Result<Vec<WebSearchResult>, ToolError> {
        // Brave / Tavily / self-hosted SearXNG, etc.
        let _ = (query, limit);
        Ok(vec![])
    }
}

let ctx = Arc::new(WebContextBuilder::new().search(MySearch).build()?);
let _tools = all_tools(ctx);
```

**Default search (DuckDuckGo)**

`DuckDuckGoSearchBackend`: Instant Answer JSON; falls back to HTML parsing (`result__a`, `uddg=` decoding). Page layout may change—use a paid API or your own index in production.

**Default fetch (direct + htmd)**

`DirectFetchBackend`: `web_fetch` allows only `http` / `https` (checked in `ops`); HTML is converted to Markdown with `htmd`. Swap in Jina Reader, headless browser, etc. via a custom [`WebFetchBackend`](backend.rs).

## `web_search`

Search the web; returns snippets.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `query` | `string` | yes | Query string |
| `limit` | `number` | no | Default 5 |

**Returns**

| Field | Type |
|-------|------|
| `results` | `Result[]` |
| `results[].title` | `string` |
| `results[].url` | `string` |
| `results[].snippet` | `string` |

---

## `web_fetch`

Fetch a URL and convert HTML to Markdown.

| Parameter | Type | Required |
|-----------|------|----------|
| `url` | `string` | yes |

**Returns**

| Field | Type |
|-------|------|
| `content` | `string` |
| `title` | `string` |
| `url` | `string` | Final URL after redirects |

## Error codes

- Missing/invalid string args: [`core/json.rs`](../core/json.rs) → `INVALID_PATH`
- Network / `limit`: [`error.rs`](error.rs) `WebErrorCode` → `NETWORK_ERROR`

| Code | Meaning |
|------|---------|
| `INVALID_PATH` | Bad `query` / `url` type or missing required string |
| `NETWORK_ERROR` | Bad `limit`, fetch/search failure, non-success HTTP, non-http(s) URL, etc. |