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

# Interact (`interact`)

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

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

Sources: [mod.rs](mod.rs)

Ask / confirm / notify I/O is provided by an injected [`InteractBackend`](mod.rs) (terminal, desktop, LSP, MCP, …). [`InteractContext::new`](mod.rs) takes `Arc<dyn InteractBackend>`. For hosts without wiring, [`InteractContext::unsupported`](mod.rs) makes `interact_ask` / `interact_confirm` error and `interact_notify` return `sent: false`. Tests can use [`StubInteractBackend`](backends/mod.rs).

## `interact_ask`

Ask the user and wait for an answer.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `question` | `string` | yes | Prompt |
| `options` | `string[]` | no | Non-empty → single choice; empty/absent → free text |
| `timeout` | `number` | no | Seconds; interpreted by backend |

**Returns**

| Field | Type |
|-------|------|
| `answer` | `string` |

---

## `interact_confirm`

Ask for yes/no.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `message` | `string` | yes | Prompt |
| `default` | `boolean` | no | On timeout/no response; default `false` |
| `timeout` | `number` | no | Seconds |

**Returns**

| Field | Type |
|-------|------|
| `confirmed` | `boolean` |

---

## `interact_notify`

Fire-and-forget notification.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `message` | `string` | yes | Body |
| `level` | `"info" \| "warning" \| "error"` | no | Default `"info"` |

**Returns**

| Field | Type |
|-------|------|
| `sent` | `boolean` | Backend-reported success (often `false` with no backend) |

## Error codes

| Code | Meaning |
|------|---------|
| `INVALID_PATH` | Missing/invalid string args (`core::json`) |
| `INTERACT_NOT_SUPPORTED` | No usable backend (`unsupported` for ask/confirm) |
| `INTERACT_TIMEOUT` | Custom backends may use this `ToolError.code` |
| `INTERACT_CANCELLED` | User cancelled; same pattern |
| `INTERACT_INVALID_PARAM` | e.g. invalid `level` |