Accept all tracked changes in document order.

Returns a JSON object with the count of accepted changes: {"accepted": int}.

Accept a single tracked change by its change_id.

For insertions: keeps the inserted text (unwraps w:ins). For deletions: discards the deleted text (removes w:del).

Args: change_id: The integer id attribute of the w:ins or w:del element.

Accept tracked changes — keep insertions, remove deletions. Empty author = all.

Add a named bookmark wrapping the specified paragraph.

Add a new column to every row of a table. First row gets header_text.

Add a comment anchored to a paragraph.

Wrap a paragraph in an SDT content control.

Args: para_id: paraId of the paragraph to wrap. tag: Unique tag name for the control. control_type: One of text|checkbox|dropdown|date. label: Optional display label (w:alias). options: List of option strings for dropdown controls. default: Default display text (or date string for date controls).

Add a cross-reference link from one paragraph to another.

Add an endnote to a paragraph.

Insert a LaTeX equation as OMML. Requires: pip install latex2mathml.

Args: para_id: paraId of the paragraph after which the equation is inserted. latex: LaTeX source string (e.g. r"\frac{1}{2}").

Insert a Word field at end of paragraph.

Common field codes: PAGE, NUMPAGES, DATE, SEQ Figure, REF MyBookmark, STYLEREF Heading.

Args: para_id: w14:paraId of the target paragraph. field_code: The field instruction text (e.g. "PAGE"). cached_value: Optional display text cached in the document.

Add a footnote to a paragraph. url, if provided, is rendered as a hotlink.

Add a subsequent reference to an existing footnote without creating a new definition.

Use when the same source must be cited again in a different paragraph. Inserts a hyperlink-wrapped footnoteReference that navigates to the same footnote as the original citation. Does not duplicate the footnote definition in footnotes.xml.

Append an external hyperlink at the end of a paragraph.

Creates a relationship entry in word/_rels/document.xml.rels and a w:hyperlink element with a Hyperlink-styled run in word/document.xml.

Args: para_id: w14:paraId of the target paragraph. text: Display text for the hyperlink. url: The URL the hyperlink points to.

Append an internal anchor hyperlink (w:anchor) at the end of a paragraph.

Internal links reference bookmarks by name and do NOT add a relationship.

Args: para_id: w14:paraId of the target paragraph. text: Display text for the hyperlink. bookmark: Name of the bookmark to link to.

Apply list formatting to paragraphs (bullet or numbered).

Insert a page break after a paragraph.

Add a section break at a paragraph. break_type: nextPage/continuous/evenPage/oddPage.

Insert a new table after a paragraph with tracked insertion.

Add a row to a table with tracked insertion. row_idx=-1 appends.

Apply a style to a list of paragraphs by their paraIds.

Args: para_ids: List of paragraph paraIds to update. style_name_or_id: Style name or styleId to apply.

Returns: {"applied": int, "style_id": str, "para_ids": list[str]}

Apply a paragraph style to every cell in a table (e.g. "TableText", "Table-Text"). Use after add_table + copy_table_style to match template formatting.

Run a comprehensive structural audit of the document.

Add Bates numbering stamp to document footer.

Args: prefix: Bates prefix string (e.g. "ACME-"). start: Starting Bates number. digits: Zero-padding width for the number. position: Hint for stamp position (currently "footer-right").

Find and replace text across all body paragraphs, handling text split across runs. replacements maps search_text -> replacement_text (case-sensitive).

Scan the document for accessibility issues.

Checks images for missing alt text and tables for missing header rows.

Returns: {"issue_count": int, "issues": list[dict]}

Remove all character formatting from a run, causing it to inherit paragraph/style defaults.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run.

Close a document and clean up temporary files.

Args: document_handle: Handle of the document to close. Empty = __default__ slot.

Clause-aware diff between the open contract and another .docx file.

Diff two DOCX files and produce a tracked-change document.

Paragraph-level LCS diff:

• Unchanged paragraphs copied verbatim.

• Deleted paragraphs (in base, absent in revised) wrapped in w:del.

• Inserted paragraphs (in revised, absent in base) wrapped in w:ins.

• Modified paragraphs (1:1 replacement) get word-level del+ins inline.

The output is a valid DOCX readable in Word/LibreOffice showing the changes as tracked revisions.

Args: base_path: Path to the original DOCX. revised_path: Path to the revised DOCX. output_path: Destination path. Auto-generated if empty.

Convert the open document to PDF using LibreOffice headless.

Requires LibreOffice to be installed ('libreoffice' or 'soffice' on PATH).

Args: output_path: Destination path for the output PDF file.

Returns: {"pdf_path": str}

Save a complete snapshot of the open document to a new path.

The active session and source path are unchanged.

Args: output_path: Destination file path (must end in .docx).

Returns: {"copied_to": output_path}

Deep-copy an existing style under a new name.

Args: source_name_or_id: Name or styleId of the style to copy. new_name: Name for the new style (spaces stripped for styleId).

Returns: {"style_id": str, "name": str, "type": str}

Deep-copy a table and insert the copy immediately after the original.

Args: table_idx: 0-based table index.

Returns: {"source_index": int, "new_index": int}

Copy borders, width, and style from one table to another. Use after add_table to make new tables match existing template tables.

Create a new blank .docx document (or from a .dotx template).

The document is automatically opened for editing under the given handle. Use save_document to save changes, or start editing immediately with insert_text, add_table, etc.

Args: output_path: Path for the new .docx file. template_path: Optional path to a .dotx template file. document_handle: Optional handle to store this document under.

Create a new .docx document from markdown content.

Supports full GitHub-Flavored Markdown: headings, bold/italic/strikethrough, links, images, bullet/numbered/nested lists, code blocks, blockquotes, tables, footnotes, and task lists. Smart typography (curly quotes, em/en dashes, ellipses) is applied automatically.

Provide exactly one of md_path or markdown. The document is automatically opened for editing under the given handle.

Args: output_path: Path for the new .docx file. md_path: Path to a .md file. Mutually exclusive with markdown. markdown: Raw markdown text. Mutually exclusive with md_path. template_path: Optional path to a .dotx template file. document_handle: Optional handle to store this document under.

Create a multilevel list in numbering.xml. Each level dict: {num_fmt, lvl_text, indent, hanging, style?}.

Create a new style in the document.

Args: name: Style name (used as styleId after removing spaces). style_type: "paragraph", "character", "table", or "numbering". based_on: Optional styleId this style inherits from. next_style: Optional styleId applied to the next paragraph.

Insert a table from CSV text.

Delete a column (0-based) from every row of a table.

Delete a comment and remove its range markers from the document.

Args: comment_id: ID of the comment to delete.

Remove an SDT content control wrapper, keeping its content in place.

Args: control_id: The w:id value of the content control to unwrap.

Delete a custom document property by name.

Args: name: Property name to delete.

Delete an endnote and its in-body reference.

Removes the endnote definition from endnotes.xml and removes the endnoteReference run from the document body.

Args: endnote_id: The numeric ID of the endnote to delete.

Remove a complete complex field (begin through end runs) from the document.

Args: field_id: Positional identifier returned by list_fields (e.g. "field_0").

Delete a footer by location: default, first, or even.

Delete a footnote and its in-body reference.

Removes the footnote definition from footnotes.xml and removes the footnoteReference run from the document body.

Args: footnote_id: The numeric ID of the footnote to delete.

Delete a header by location: default, first, or even.

Remove the drawing containing the image with the given rId from the document.

Also removes the relationship entry from word/_rels/document.xml.rels.

Args: rId: The relationship ID of the image to delete (e.g. 'rId5').

Delete the paragraph with the given paraId.

Args: para_id: paraId of the paragraph to remove.

Remove a section break from a paragraph.

Removes the w:sectPr from the paragraph's w:pPr. After removal the paragraph's content flows into the next section rather than ending one.

Args: para_id: paraId of the paragraph that holds the section break.

Raises: ValueError: If the paragraph has no section break.

Delete a style from the document.

Args: name: Style name or styleId (case-insensitive).

Delete a table by index (0-based). Raises IndexError if out of range.

Delete a table row with tracked changes.

Delete text from a paragraph.

Finds the text within the paragraph (across run boundaries if needed). With tracked=True (default) the deleted text stays visible as red strikethrough in Word's Track Changes view — the human reviewer must accept the deletion to remove it permanently. With tracked=False the text is removed immediately.

Provide context_before/context_after to disambiguate when the same text appears multiple times, or when it contains smart quotes / special whitespace.

Args: para_id: paraId of the target paragraph. text: Text to delete (ASCII quotes/dashes/spaces match their Unicode equivalents). author: Author name shown in Word's review pane (tracked=True only). context_before: Text immediately before the target (for precise anchoring). context_after: Text immediately after the target (for precise anchoring). ignore_case: If True, match text and context case-insensitively. tracked: True (default) = red strikethrough the human accepts/rejects. False = text removed immediately, no markup. document_handle: Optional handle for concurrent session isolation.

Increase the list indentation level (ilvl) of a paragraph by 1, maximum 8.

Returns {para_id, ilvl}. Raises ValueError if paragraph is not a list item.

Compare two separate DOCX files and produce a tracked-change DOCX plus a plain-text summary.

Use this when you have two distinct files (e.g. an original and a revised copy) and want to show what changed between them. Produces:

1. A DOCX with tracked-change markup (deletions in red, insertions underlined).

2. A .txt summary suitable for pasting into an email or pull-request description.

If you have already made tracked edits to the currently open document and just want to summarise those changes, use generate_change_summary instead.

Args: base_path: Path to the original DOCX. revised_path: Path to the revised DOCX. docx_output: Output path for the tracked-change DOCX (auto-generated if empty). text_output: Output path for the plain-text summary .txt (auto-generated if empty).

Deep-copy a table row and insert the copy immediately after it.

Args: table_idx: 0-based table index. row_index: 0-based index of the row to duplicate.

Returns: {"row_index": int, "new_row_index": int}

Edit text in a header or footer.

By default (tracked=True) the change is recorded as a deletion of the old text and an insertion of the new text — the human reviewer accepts/rejects in Word. Pass tracked=False to replace the text directly with no revision markup.

Args: location: "header" or "footer" (matches the first found of that type). old_text: Text to find and replace. new_text: Replacement text. author: Author name shown in Word's review pane (tracked=True only). tracked: True (default) = tracked del+ins. False = direct replacement, no markup. document_handle: Optional handle for concurrent session isolation.

Export the open document as Markdown.

Converts the document body (headings, bold/italic runs, lists, tables, plain paragraphs) to GitHub-Flavoured Markdown and writes it to a file.

Args: output_path: Destination path for the .md file. Defaults to /export.md when empty.

Returns: {"output_path": str, "paragraphs": int, "tables": int}

Write session operations as a Python replay script.

Returns: {"output_path": str, "operations": int}

Extract full structure: all paragraphs (index, style, text, paraId) and tables (index, dimensions, cell content). Use to map a template before filling it.

Replace all text in a paragraph by its zero-based index, preserving the paragraph style and first run's formatting. Use get_all_paragraphs first to find the index.

Fill SDT content controls from data dict. Keys match w:tag values.

Args: data: Mapping of tag names to values. Use list[str] for repeating sections. remove_empty: If True, remove SDTs with no matching key in data.

Find all occurrences of a string and replace with formatted text.

Replaces every occurrence of find across all paragraphs in the document with replace, applying the specified character formatting to the replacement run only.

Args: find: Text to search for (must be non-empty). replace: Replacement text. bold: True to bold, False to explicitly un-bold, None to leave unchanged. italic: True to italicise, False to explicitly un-italicise, None to leave unchanged. color: Font color as 6-digit hex (e.g. "FF0000"). None leaves color unchanged. size_pt: Font size in points (e.g. 12.0). None leaves size unchanged.

Accept all tracked changes and remove all revision markup.

Accepts every w:ins / w:del and strips all w:rPrChange and w:pPrChange elements, leaving plain text with no tracked-change metadata.

Returns: {"changes_accepted": int, "formatting_changes_removed": int}

Summarise tracked changes already present in the open document as an email-ready .txt.

Use this after making edits with tracked=True (the default) and saving, to produce a human-readable change log of what was modified. Reads the document's existing w:ins / w:del elements, groups adjacent deletion+insertion pairs as REPLACEMENT entries, and writes a numbered list with author, date, and text per change.

Typical workflow: open_document → edit with tracked=True → save_document → generate_change_summary

If you have two separate files to compare rather than an already-edited document, use diff_to_text instead.

Args: output_path: Destination .txt path. Auto-generated from the document stem if empty. document_handle: Optional handle for concurrent session isolation.

Insert a List of Figures field (requires SEQ Figure captions).

Insert a List of Tables field (requires SEQ Table captions).

Generate a privilege log DOCX from document metadata.

Args: output_path: Destination path. If empty, writes to a temp file.

Write a DOCX table of all redactions made this session.

Args: output_path: Destination path. If empty, writes to a temp file.

Generate a Table of Contents from document headings.

Insert a Table of Figures field block after the paragraph with para_id.

Collects caption-styled paragraphs starting with 'Figure' as entries.

Insert a Table of Tables field block after the paragraph with para_id.

Collects caption-styled paragraphs starting with 'Table' as entries.

Return all body paragraphs with index, style, text, and paraId. Use to discover indices for fill_paragraph_by_index or paraIds after inject_para_ids.

Get the alt text and title for an image by 0-based index.

Args: image_index: 0-based index across all wp:docPr elements in document.xml.

Returns: {"image_index": int, "alt_text": str, "title": str}

Return the full accepted-view text of the document.

Accepted view: w:ins text included, w:del text excluded. Includes text inside w:hyperlink runs. Paragraphs are joined by newline. Footnote text is returned separately.

Returns JSON: {"body": str, "footnotes": str}

Get the text content within a named bookmark.

Return text content of a specific cell.

Args: table_idx: 0-based table index. row_idx: 0-based row index. col_idx: 0-based column index.

Returns: {"table_index": int, "row_index": int, "col_index": int, "text": str}

List all comments with their ID, author, date, and text.

Return details of a single content control by its w:id.

Args: control_id: The w:id value of the content control to retrieve.

List all SDT content controls in the document.

Get custom document properties from docProps/custom.xml.

Get overview stats: paragraph count, headings, footnotes, comments, images.

Return a flat list of headings as a document outline.

Walks the document body and returns every heading paragraph up to the specified level.

Args: max_level: Maximum heading level to include (1–6, default 6).

Returns: JSON list of dicts with keys: level (int), text (str), para_id (str).

Get all endnotes with their ID and text content.

Return all equations in the document as OMML XML strings.

Return details of a single field by field_id.

Args: field_id: Positional identifier returned by list_fields (e.g. "field_0").

List all footnotes with their ID and text content.

Get all headers and footers with their text content.

Get the document heading structure with levels, text, and paraIds.

Returns a list of headings in document order, each with:

• level (1-9)

• text (heading content)

• style (e.g., "Heading1")

• paraId (unique paragraph identifier for targeting edits)

Get all embedded images with rId, filename, content type, and dimensions.

Return all list definitions from numbering.xml.

Each entry: {abstract_num_id, num_format, levels}. Returns [] if no numbering.xml exists.

Get the full text and style of a specific paragraph by its paraId.

Args: para_id: The 8-character hex paraId (e.g., "1A2B3C4D").

Read all formatting attributes of a paragraph.

Returns style, alignment, indentation, line spacing, border, shading, and list info.

Args: para_id: paraId of the target paragraph.

Get core document properties (title, creator, subject, dates, revision).

Estimate reading time for the open document.

Args: words_per_minute: Assumed reading speed (default 200 wpm).

Returns: {"word_count": int, "words_per_minute": int, "minutes": float, "seconds": int}

Get all runs in a paragraph with their formatting properties.

Args: para_id: paraId of the target paragraph.

List all sections in the document with their properties.

Returns a JSON array of section objects, each containing: index, break_type, page_width, page_height, orientation, columns, margin_top, margin_bottom (all sizes in twips/DXA). The final section always has break_type="".

Return all operations performed this session as replayable JSON.

Return document statistics for the open document.

Returns a dict with keys: word_count, character_count, paragraph_count, table_count, image_count, section_count.

Get details of a single style by name or styleId (case-insensitive).

Args: name_or_id: Style name or styleId to look up.

Returns: {"style_id": str, "name": str, "type": str, "base_style": str, "next_style": str}

Get all defined styles with ID, name, type, and base style.

Get structured info for a single table by zero-based index.

Args: table_idx: 0-based table index.

Returns: {"index": int, "row_count": int, "col_count": int, "cells": list[list[str]]}

Get all tables with row/column counts and cell text content.

Return the template style map: default font/size, named paragraph styles, table styles, and page margins. Use before filling to match formatting.

Return the named color slots from word/theme/theme1.xml.

Returns a dict mapping slot names (dk1, lt1, accent1, ...) to 6-digit hex strings. Returns an empty dict if the document has no theme file.

Return all pending tracked changes (insertions and deletions) as a JSON list.

Each entry contains: type, change_id, author, date, para_id, text. Changes are returned in document order.

Return the word count of the open document body.

Returns: {"word_count": int}

Assign w14:paraId to every paragraph missing one, so paraId-based tools work. Returns the count injected. Run once on templates created without paraIds.

Insert a native bar chart (no Excel required).

series: [{"name": str, "values": [float, ...]}]

Insert a blockquote paragraph after the given paragraph.

The new paragraph has 720-twip left indent and italic formatting.

Args: para_id: paraId of the reference paragraph (new para inserted after it). text: Text content of the blockquote.

Insert a caption paragraph after the specified paragraph.

Args: after_para_id: paraId of the paragraph to insert after. text: Caption description text (without label/number prefix). label: Caption label, e.g. "Figure" or "Table" (default "Figure").

Insert a code-block paragraph after the given paragraph.

The new paragraph uses Courier New 10pt with light-gray background shading.

Args: para_id: paraId of the reference paragraph (new para inserted after it). text: Code text content. language: Optional language hint (stored in return value only).

Insert a DATE field at the end of a paragraph.

Args: para_id: w14:paraId of the target paragraph. date_format: Date picture switch (default: @ "MMMM d, yyyy").

Insert a floating (anchored) image. wrap: square|topbottom|none.

Insert a Word IF conditional field at the end of a paragraph.

Args: para_id: w14:paraId of the target paragraph. condition: The condition expression (e.g. "x > 0"). true_text: Text to display when condition is true. false_text: Text to display when condition is false.

Insert an image after a paragraph. Size in cm (preferred) or EMU; cm overrides EMU.

align sets the image paragraph alignment (left/center/right).

Insert a native line chart.

series: [{"name": str, "values": [float, ...]}]

Insert a MERGEFIELD (mail merge) field at the end of a paragraph.

Args: para_id: w14:paraId of the target paragraph. field_name: The merge field name (e.g. "FirstName").

Insert a PAGE field at the end of a paragraph.

Args: para_id: w14:paraId of the target paragraph.

Insert a new paragraph after the paragraph with the given paraId.

Args: after_para_id: paraId of the paragraph to insert after. text: Text content for the new paragraph. style: Optional paragraph style name (e.g., "Heading1", "Normal").

Insert a native pie chart (single series, fixed 14x9 cm).

series: [{"name": str, "values": [float, ...]}]

Insert a SEQ (sequence) field for figure/table numbering.

Args: para_id: w14:paraId of the target paragraph. seq_name: The sequence identifier (e.g. "Figure", "Table"). reset: If True, restarts the sequence counter at 1.

Insert text into a paragraph.

By default (tracked=True) the insertion is marked as a proposed addition that appears underlined in Word's Track Changes view. The human reviewer must accept it in Word before it becomes permanent. Pass tracked=False to write the text directly with no revision markup.

Args: para_id: paraId of the target paragraph. text: Text to insert. position: Where to insert — "start", "end", or a substring to insert after. author: Author name shown in Word's review pane (tracked=True only). context_before: Text immediately before the insertion point (for precise anchoring). context_after: Text immediately after the insertion point (for precise anchoring). ignore_case: If True, match context_before/context_after case-insensitively. tracked: True (default) = revision markup the human accepts/rejects in Word. False = text written directly, no markup. document_handle: Optional handle for concurrent session isolation.

Insert an inline text box after the paragraph with para_id.

Args: para_id: paraId of the reference paragraph (insert after this). text: Text content for the text box. width_cm: Width in centimetres (default 5.0). height_cm: Height in centimetres (default 2.0).

Returns: JSON with para_id (new paragraph), text, width_cm, height_cm.

Insert a VML watermark into the document's default header.

Places a <v:shape> with a <v:textpath> inside the default header, which is the standard Word watermark pattern.

Args: text: Watermark text (e.g. "DRAFT", "CONFIDENTIAL"). diagonal: If True (default), diagonal orientation; if False, horizontal. document_handle: Optional handle for concurrent session isolation.

List all bookmarks in the document.

List all comment threads (root comments with their replies).

Returns a list of thread dicts: {root: {id, author, date, text}, replies: [...]}.

List all fields in the document with their codes and cached values.

List all hyperlinks in the document.

Returns a list of dicts with keys: id, url_or_anchor, text, para_id, type. type is "external" (r:id based) or "internal" (w:anchor based).

List all XML parts (files) in the open DOCX zip.

List all SDT template fields (tag, label, type) in the document.

Lock a content control to prevent editing.

Args: tag: Tag name of the control to lock. lock: Lock type — sdtLocked|contentLocked|sdtContentLocked.

Merge a rectangular range of cells. Horizontal: gridSpan. Vertical: vMerge.

Merge another DOCX document's content into the current document.

Merge tracked changes from N reviewer copies into the open document.

Modify a table cell.

By default (tracked=True) the old content is marked as a deletion and the new content as an insertion — the human reviewer accepts/rejects in Word's Track Changes view. Pass tracked=False to overwrite the cell directly with no markup.

Args: table_idx: Table index (0-based). row: Row index (0-based). col: Column index (0-based). text: New cell text. author: Author name shown in Word's review pane (tracked=True only). tracked: True (default) = tracked del+ins. False = direct overwrite, no markup. document_handle: Optional handle for concurrent session isolation.

Open a .docx file for reading and editing.

Unpacks the DOCX archive, parses all XML parts, and caches them in memory under a handle. Multiple documents may be open concurrently, each under its own handle.

Args: path: Absolute path to the .docx file. document_handle: Optional handle to store this document under. Empty string uses the shared __default__ slot (legacy behavior); pass a unique value (e.g. a UUID) per concurrent session for isolation.

Decrease the list indentation level (ilvl) of a paragraph by 1, minimum 0.

Returns {para_id, ilvl}. Raises ValueError if paragraph is not a list item.

Read raw XML of any DOCX part (e.g. 'word/document.xml'). Use list_parts() to discover available parts.

True redaction: remove text and replace with black rectangle. Use exact_text or pattern.

Args: pattern: Regex pattern to match run text. para_ids: Optional list of paragraph paraId values to limit scope. exact_text: Exact string to match against run text. reason: Reason for redaction (stored in log).

Reject all tracked changes in document order.

Returns a JSON object with the count of rejected changes: {"rejected": int}.

Reject a single tracked change by its change_id.

For insertions: discards the inserted text (removes w:ins). For deletions: keeps the deleted text (unwraps w:del, restoring text).

Args: change_id: The integer id attribute of the w:ins or w:del element.

Reject tracked changes — remove insertions, restore deleted text.

Remove a bookmark by name (keeps paragraph content).

Remove a hyperlink wrapper, preserving the text runs inside.

The paragraph text remains; only the w:hyperlink element is unwrapped.

Args: para_id: w14:paraId of the paragraph containing the hyperlink. url_or_anchor: URL (for external) or bookmark name (for internal) to match.

Remove VML watermarks (e.g., DRAFT) from all document headers.

Replace text in a paragraph.

With tracked=True (default) the old text is shown as red strikethrough and the new text as an underlined insertion — the human reviewer accepts/rejects in Word. Only the actually-changed portion is marked; common leading/trailing text is left as plain runs. With tracked=False the replacement is applied immediately without any visible markup.

Args: para_id: paraId of the target paragraph. find: Text to find and replace (may span run boundaries). replace: Replacement text. author: Author name shown in Word's review pane (tracked=True only). context_before: Text immediately before the target (for precise anchoring). context_after: Text immediately after the target (for precise anchoring). tracked: True (default) = strikethrough + underline the human accepts/rejects. False = replaced immediately, no markup. document_handle: Optional handle for concurrent session isolation.

Reply to an existing comment (creates a threaded reply).

Mark a comment as resolved (sets w15:done='1' in commentsExtended.xml).

Args: comment_id: ID of the comment to resolve.

Restart list numbering at a paragraph. Adds lvlOverride with startOverride.

Write a sanitized copy of the open document to output_path.

Level 1: Remove rsid session-fingerprint attributes from document.xml. Level 2: + Replace tracked-change author names (w:author on w:ins/w:del). Level 3: + Clear creator/lastModifiedBy/revision in docProps/core.xml + Clear Company in docProps/app.xml + Remove attachedTemplate reference from word/settings.xml

Args: output_path: Destination path for the sanitized DOCX. Must be non-empty. level: Sanitization depth (1, 2, or 3). Default 1. redact_authors_as: Replacement author string for level 2+. Default "Anonymous".

Save all changes back to a .docx file.

Args: output_path: Path for the output file. If empty, overwrites the original source path of the document under this handle. document_handle: Handle of the document to save. Empty = __default__.

[EXPERIMENTAL] Detect and redact PII from the open document using Presidio + spaCy NER.

WARNING: This tool WILL miss PII. It is experimental and NOT suitable for production use or as the sole control for privileged, regulated, or legally sensitive documents. Always run with dry_run=True first and manually review every detected entity before committing a redacted file.

Known limitations (statistical NER gaps):

• Names in ALL-CAPS (ledger headers, table cells) are frequently missed.

• Single-token names with no surrounding context are unreliable.

• Non-English names (Arabic, CJK, African) have low recall on this English model.

• Names embedded in legal boilerplate ("Borrower: Jane Doe") are often skipped.

NER model (en_core_web_lg, ~560MB) downloads automatically on first use.

Detects: PERSON, EMAIL_ADDRESS, PHONE_NUMBER, CREDIT_CARD, SSN, IP_ADDRESS, IBAN_CODE, US_BANK_NUMBER, US_PASSPORT, and more via Presidio.

Redacted text is replaced with a solid black DrawingML rectangle — true XML redaction where the original text is deleted from the OOXML entirely, not merely hidden by formatting.

Args: output_path: Destination path. Required when dry_run=False. entities: Presidio entity types to redact. None = all detected types. confidence_threshold: Presidio score floor (default 0.35). dry_run: If True, detect only — return entity list, write no file. also_sanitize_metadata: Apply level-3 metadata sanitization (default True). redact_authors_as: Replacement author string for metadata pass.

Search for text across the document body, footnotes, and comments.

Args: query: Text to search for (case-insensitive), or a regex pattern. regex: If true, treat query as a Python regular expression.

Returns matching paragraphs with their paraId, source part, and context.

Set the alt text (and optionally title) on an image by 0-based index.

Args: image_index: 0-based index across all wp:docPr elements in document.xml. alt_text: Accessibility description to set on the image. title: Optional title attribute; removed from XML if empty.

Returns: {"image_index": int, "alt_text": str}

Set background shading fill color on a table cell.

Set vertical alignment of a table cell: top, center, or bottom.

Set the width of a table cell in millimetres (stored as DXA).

Set vertical character position (raised/lowered) for a specific run.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. position_pt: Offset in points (positive = raised, negative = lowered).

Set character spacing (tracking) for a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. spacing_pt: Spacing in points (positive = expanded, negative = condensed).

Set column widths in cm. len(widths_cm) must match column count.

Update the value/text of a content control by its tag.

Args: tag: Tag name of the control to update. value: New value. For checkbox: 'true'/'1' = checked, 'false'/'0' = unchecked.

Set (upsert) a custom document property.

Args: name: Property name. value: Property value as a string. vt_type: VT type element name (lpwstr, i4, bool, etc.).

Enable or disable a different first-page header/footer for a section.

When enabled, the section can have a unique header/footer on its first page, separate from the header/footer used on subsequent pages.

Args: section_index: Zero-based section index (use get_sections to find it). enabled: True to enable different first page, False to disable.

Returns: {"section_index": int, "different_first_page": bool}

Set the default document language.

Writes the BCP-47 language tag into the default paragraph style's run properties (w:rPr/w:lang) in word/styles.xml.

Args: language_code: BCP-47 language tag, e.g. "en-US", "fr-FR", "de-DE".

Returns: {"language": language_code}

Set document protection. edit: trackedChanges/comments/readOnly/forms/none.

Apply character formatting to text with tracked-change markup.

Mark the first row as a repeating header row.

Set accessibility alt text and title on an embedded image.

Args: rId: The relationship ID of the image. alt_text: Alt text (descr attribute on wp:docPr). title: Optional title attribute on wp:docPr.

Set or remove a border on an embedded image.

Args: rId: The relationship ID of the image (e.g. 'rId6'). border_pt: Border width in points. Use 0 to remove the border. color: RGB hex color string without '#' (default '000000' = black).

Returns: JSON with rId, border_pt, and color fields.

Resize an embedded image by updating its EMU extent attributes.

Args: rId: The relationship ID of the image to resize. width_cm: New width in centimetres. height_cm: New height in centimetres.

Keep all lines of this paragraph on the same page.

Args: para_id: paraId of the target paragraph. enabled: True to enable keep-lines-together, False to remove it.

Keep this paragraph on the same page as the next paragraph.

Args: para_id: paraId of the target paragraph. enabled: True to enable keep-with-next, False to remove it.

Set line spacing and paragraph spacing.

Args: para_id: paraId of the target paragraph. line_rule: "auto" | "exact" | "atLeast". None leaves unchanged. line_value: For "auto": 240=single, 360=1.5x, 480=double. For "exact"/"atLeast": twips. space_before_pt: Space before paragraph in points (None = unchanged). space_after_pt: Space after paragraph in points (None = unchanged).

Enable or disable different odd/even page headers globally.

This is a document-level setting stored in word/settings.xml. When enabled, even-numbered pages can use a different header/footer from odd-numbered pages.

Args: enabled: True to enable different odd/even headers, False to disable.

Returns: {"odd_even_headers": bool}

Force a page break before this paragraph.

Args: para_id: paraId of the target paragraph. enabled: True to force page break before, False to remove it.

Set page margins from millimetre values.

Args: top_mm: Top margin in mm. None = unchanged. bottom_mm: Bottom margin in mm. None = unchanged. left_mm: Left margin in mm. None = unchanged. right_mm: Right margin in mm. None = unchanged. para_id: paraId of paragraph with section break. None = body section.

Set page orientation, swapping width/height dimensions if needed.

Args: orientation: "portrait" or "landscape". para_id: paraId of paragraph with section break. None = body section.

Set page size from millimetre values.

Args: width_mm: Page width in mm (e.g. 210 for A4, 215.9 for Letter). height_mm: Page height in mm (e.g. 297 for A4, 279.4 for Letter). para_id: paraId of paragraph with section break. None = body section.

Set borders on one or more sides of a paragraph.

Args: para_id: paraId of the target paragraph. sides: List of sides: "top", "bottom", "left", "right", "between". color: Border color as 6-digit hex (default "000000"). size: Border width in eighths of a point (default 4 = 0.5pt).

Set indentation on a paragraph.

Args: para_id: paraId of the target paragraph. left_cm: Left indent in centimetres (None = unchanged). right_cm: Right indent in centimetres (None = unchanged). first_line_cm: First-line indent in cm (mutually exclusive with hanging_cm). hanging_cm: Hanging indent in cm (mutually exclusive with first_line_cm).

Set background shading on a paragraph.

Args: para_id: paraId of the target paragraph. fill_color: Fill color as 6-digit hex (e.g., "FFFF00"). pattern: Shading pattern (default "clear").

Set core document properties. Empty string = unchanged.

Set row height in millimetres. rule: exact, atLeast, or auto.

Set the font color of a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. color: Hex color without # (e.g., "FF0000").

Set the font of a specific run (zero-based index) in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. font_name: Font name (e.g., "Arial", "Times New Roman").

Set highlight color of a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. color: Word highlight color name (e.g., "yellow", "green", "cyan", "none").

Set the language on a run for spell-checking purposes.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. language_code: BCP-47 language code (e.g., "en-US", "fr-FR", "de-DE").

Set the font size of a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. size_pt: Font size in points (e.g., 12.0).

Set strikethrough on a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. double: False for single strikethrough, True for double strikethrough.

Set subscript vertical alignment on a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run.

Set superscript vertical alignment on a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run.

Set underline style on a specific run in a paragraph.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. style: Underline style (e.g., "single", "double", "dotted", "none").

Set the number of columns in a section.

Args: section_index: Zero-based section index (use get_sections to find it). num_columns: Number of text columns (1 = single column). equal_width: If True, all columns are equal width. Default True.

Modify section properties (page size, orientation, margins). 0/empty = unchanged.

Set table alignment: left, center, or right.

Set borders on all six sides of a table (top, bottom, left, right, insideH, insideV).

Apply a named table style (e.g. TableGrid, LightShading-Accent1) to a table.

Set text case transformation on a run.

Args: para_id: paraId of the target paragraph. run_idx: Zero-based index of the run. case: "upper" (all caps), "small" (small caps), or "none" (remove case transform).

Update a named color slot in the document theme.

Args: slot: One of dk1, lt1, dk2, lt2, accent1-accent6, hlink, folHlink. hex_color: 6-character hex string without # (e.g. "FF0000").

Enable or disable revision tracking in the document.

When enabled, Word/LibreOffice will record future edits as tracked changes.

Args: enabled: True to enable tracking, False to disable. author: Optional author name (stored in response for reference only).

Returns: {"track_changes": bool, "author": str}

Enable widow/orphan control for this paragraph.

Args: para_id: paraId of the target paragraph. enabled: True to enable widow control, False to remove it.

Sort the non-header rows of a table by the text content of a column.

Header rows (marked with w:tblHeader) remain at the top. Rows with a missing cell at column_index sort as empty string.

Args: table_idx: 0-based table index. column_index: 0-based column to sort by. ascending: True for A→Z (default), False for Z→A.

Returns: {"sorted_rows": int, "column_index": int, "ascending": bool}

Split the open document into multiple DOCX files, one per heading section.

Args: output_dir: Directory for output files. Defaults to /split_output. at_heading_level: Heading level to split on (default 1).

Returns: {"output_dir": str, "files": list[str], "parts": int}

Split a table into two tables at the given row index.

Rows 0..at_row_index-1 remain in the original table; rows at_row_index..end move to a new table inserted immediately after.

Args: table_idx: 0-based table index. at_row_index: 0-based row index to split at (must be > 0 and < row_count).

Returns: {"table1_rows": int, "table2_rows": int}

Remove list numbering from a paragraph by setting numId to 0.

Export a table as CSV string.

Replace data series in an existing chart by chart_id.

series: [{"name": str, "values": [float, ...]}]

Replace the text of an existing comment.

Args: comment_id: ID of the comment to update. text: New comment text.

Modify properties of an existing content control.

Args: control_id: The w:id value of the content control to update. title: New title (w:alias/@w:val). Omit to leave unchanged. tag: New tag (w:tag/@w:val). Omit to leave unchanged. placeholder_text: New placeholder text. Omit to leave unchanged.

Update the text of an existing endnote.

Args: endnote_id: The numeric ID of the endnote to update (must be >= 1). text: The new text content for the endnote.

Mark all fields as dirty so Word recalculates on open.

Update the text of an existing footnote.

Args: footnote_id: The numeric ID of the footnote to update (must be >= 1). text: The new text content for the footnote.

Update the target URL of an existing external hyperlink relationship.

Args: r_id: The relationship ID (e.g. "rId7") to update. new_url: The new target URL.

Replace the binary for an existing image in-place.

The image dimensions and position in the document are preserved.

Args: rId: The relationship ID of the image to replace. new_image_path: Absolute path to the new image file on disk.

Update the text and/or style of an existing paragraph.

Args: para_id: paraId of the paragraph to update. text: New text content. Empty string leaves text unchanged. style: New paragraph style name. Empty string leaves style unchanged.

Update an existing style's basedOn and/or next properties.

Args: name: Style name or styleId (case-insensitive). based_on: New basedOn styleId (replaces existing). next_style: New next styleId (replaces existing).

Regenerate ToC entries from current headings.

Cross-reference endnote IDs between document.xml and endnotes.xml.

Cross-reference footnote IDs between document.xml and footnotes.xml.

Check paraId uniqueness across all document parts.

Validate data dict covers all template fields. Returns missing and extra keys.

Replace a DOCX part with new XML. Validates well-formedness first. WARNING: Direct XML manipulation can corrupt the document if used incorrectly.

Run XPath against any DOCX part. Pre-bound namespaces: w, w14, r, wp, a, mc.

Examples: xpath="//w:p" — all paragraphs xpath="//w:t/text()" — all text content xpath="//w:p[w:pPr/w:pStyle/@w:val='Heading1']" — Heading 1 paragraphs