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

# Markdown (`md`)

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

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

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

## `extract_toc`

Extract an **ATX heading** table of contents (`#` … `######`). Lines inside **fenced code blocks** (`` ``` `` / `~~~`) are ignored.

Path resolution matches `fs`: relative paths join to [`MdContext`](mod.rs) workspace root; with `allow_outside_root == false`, paths must stay inside the root.

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

**Returns**

| Field | Type |
|-------|------|
| `path` | `string` |
| `toc` | `TocItem[]` |
| `toc[].level` | `number` | 1–6 |
| `toc[].title` | `string` |
| `toc[].line` | `number` | 1-based line |

---

## `markdown_stats`

Counts **non-whitespace characters**, paragraphs, ATX headings, and total lines. `characters` / `paragraphs` **exclude fenced code blocks**; `headings` counts ATX headings outside fences; `lines` includes everything.

Paragraphs are split on blank lines (`\n\n`). There is **no word count**—use `characters` for CJK/Latin without a single tokenizer definition.

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

**Returns**

| Field | Type |
|-------|------|
| `path` | `string` |
| `characters` | `number` |
| `paragraphs` | `number` |
| `headings` | `number` |
| `lines` | `number` |

## Error codes

Similar to `fs` (see [`error.rs`](error.rs)):

| Code | Meaning |
|------|---------|
| `FILE_NOT_FOUND` | Missing path or cannot resolve in sandbox |
| `PERMISSION_DENIED` | Cannot read |
| `INVALID_PATH` | Empty path, outside root, not a file, non-UTF-8, or other I/O failure |