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

# Find (`find`)

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

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

> The `find` feature is **workspace search**, distinct from web search (`web_search`). Tool names follow Unix habits: `grep_search`, `glob_search`.
>
> **`FindContext`**
>
> Like `fs`, find tools share a context: `FindContext::new(root)` canonicalizes `root` as the default scan root; `None` uses the process current directory at construction.
>
> `path` is optional for `grep_search` / `glob_search` (defaults to that root). Relative `path` joins to the default root; absolute paths resolve on the filesystem. `path` must exist as a file or directory.
>
> Traversal skips directories named `.git`. `grep_search` skips files that are not valid UTF-8.

## `grep_search`

Search file contents with a **regular expression** (Rust `regex` syntax). Plain keywords work as literals; escape metacharacters like `.` `(` when needed.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `pattern` | `string` | yes | Regex; invalid syntax → `INVALID_PATTERN` |
| `path` | `string` | no | Root dir or single file; default is `FindContext` root |
| `glob` | `string` | no | Path glob under root, e.g. `**/*.md`; invalid → `INVALID_PATTERN` |
| `ignore_case` | `boolean` | no | Default `false` |

**Returns**

| Field | Type |
|-------|------|
| `matches` | `Match[]` |
| `matches[].file` | `string` |
| `matches[].line` | `number` |
| `matches[].content` | `string` |

---

## `glob_search`

Match files by glob pattern.

| Parameter | Type | Required | Notes |
|-----------|------|----------|--------|
| `pattern` | `string` | yes | e.g. `**/*.md`; invalid → `INVALID_PATTERN` |
| `path` | `string` | no | Scan root; default `FindContext` root |

**Returns**

| Field | Type |
|-------|------|
| `files` | `string[]` |

## Error codes

See [`error.rs`](error.rs).

| Code | Meaning |
|------|---------|
| `FILE_NOT_FOUND` | Root or `path` target missing |
| `PERMISSION_DENIED` | Cannot access path |
| `INVALID_PATTERN` | Invalid regex or glob |
| `INVALID_PATH` | Bad arguments, wrong type, walk failure |