find_text
Locate text in Word documents by searching paragraphs, table cells, and optional textboxes; returns match locations with context. Filter by formatting or plain query to find specific content.
Instructions
Find text in paragraphs and table cells; returns locations plus context. include_textboxes=True also searches text-box content as labeled matches; file-mode only. Pass formatting={...} (bold, font, size_pt, color, ...) to search by EFFECTIVE formatting: resolved through run, style chain, and defaults; query=None returns every formatted stretch; scope 'body' or 'all'; file-mode, no regex. Plain queries search open documents live (same shape, 500-match cap). Read-only. To read a known range, use get_text.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| live | No | auto | |
| query | No | ||
| regex | No | ||
| scope | No | body | |
| file_path | Yes | ||
| formatting | No | ||
| context_chars | No | ||
| include_textboxes | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |