scan_directory
Scan a directory to inventory supported documents with filenames, paths, sizes, and optional OCR text previews; use list-only mode for filename-only results or recursive pagination.
Instructions
Scan a directory for documents. Returns filename, path, size, and optionally a text preview (OCR-enabled). Use listOnly=true for fast directory listing without text extraction. Supports PDF, DOCX, DOC, Pages, images, TXT, RTF, ODT.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"path": "<path>"
},
"name": "scan_directory"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Absolute path to directory | |
| limit | No | Max files to return (default: 50). Use 0 for no limit. | |
| offset | No | Skip the first N files (for pagination, default: 0) | |
| listOnly | No | If true, return only filenames/paths/sizes without text extraction (much faster for large directories, default: false) | |
| recursive | No | Scan subdirectories (default: false) |