SecurityRonin/docx-mcp

SecurityRonin/docx-mcp

от securityronin
MCP сервер, позволяющий ИИ-агенту создавать, читать и редактировать Word-документы с полным отслеживанием изменений, комментариями и структурным аудитом. Полезен юристам, консультантам и пентестерам для автоматизации контрактов и отчетов.

docx-mcp

PyPI Python License: MIT CI Coverage Sponsor

docx-mcp MCP server

Give your AI coding agent the ability to create, read, and edit Word documents. Edits appear as tracked changes in Microsoft Word — red strikethrough for deletions, green underline for insertions — and after any revision session your agent can produce an email-ready change log listing every insertion, deletion, and replacement. Or compare two separate files to get the same output automatically.

Who This Is For

Professionals who produce Word deliverables and want their AI agent to handle the document work directly:

  • Legal — contract review with tracked redlines, batch clause replacement across templates, comment annotations explaining each change, footnote management
  • Security & Penetration Testing — generate pentest reports from markdown findings, merge appendices from multiple engagements, add executive-summary comments, remove DRAFT watermarks before delivery
  • Consulting — build proposals and SOWs from templates, convert meeting notes to formatted deliverables, bulk-update payment terms across document sets
  • Compliance & Audit — structural validation of document integrity, cross-reference checking, heading-level audits, protection enforcement
accept_all_changes

Принять все отслеженные изменения в порядке документа. Возвращает JSON-объект с количеством принятых изменений: {"accepted": int}.

Принять все отслеженные изменения в порядке документа. Возвращает JSON-объект с количеством принятых изменений: {"accepted": int}.

Параметры

Без параметров.

accept_change

Принимает одно отслеживаемое изменение по его change_id. Для вставок: сохраняет вставленный текст (разворачивает w:ins). Для удалений: отбрасывает удалённый текст (удаляет w:del). Аргументы: change_id: целочисленный атрибут id элемента w:ins или w:del.

Принимает одно отслеживаемое изменение по его change_id. Для вставок: сохраняет вставленный текст (разворачивает w:ins). Для удалений: отбрасывает удалённый текст (удаляет w:del). Аргументы: change_id: целочисленный атрибут id элемента w:ins или w:del.

Параметры

  • change_idintegerобязательный
accept_changes

Принять отслеживаемые изменения - сохранить вставки, удалить удаления. Пустой автор = все.

Принять отслеживаемые изменения - сохранить вставки, удалить удаления. Пустой автор = все.

Параметры

  • authorstring
  • document_handlestring
add_bookmark

Добавить именованную закладку, оборачивающую указанный абзац.

Добавить именованную закладку, оборачивающую указанный абзац.

Параметры

  • para_idstringобязательный
  • namestringобязательный
add_column_to_table

Добавить новый столбец в каждую строку таблицы. Первая строка получает header_text.

Добавить новый столбец в каждую строку таблицы. Первая строка получает header_text.

Параметры

  • table_idxintegerобязательный
  • header_textstring
add_comment

Добавить комментарий, привязанный к абзацу.

Добавить комментарий, привязанный к абзацу.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • authorstring
  • document_handlestring
add_content_control

Оборачивает абзац в элемент управления содержимым SDT (Structured Document Tag). Аргументы: para_id: paraId абзаца, который нужно обернуть. tag: Уникальное имя тега для элемента управления. control_type: Одно из значений: text|checkbox|dropdown|date. label: Необязательная отображаемая подпись (w:alias). options: Список строк-вариантов для элементов управления типа dropdown. default: Текст по умолчанию (или строка даты для элементов управления типа date).

Оборачивает абзац в элемент управления содержимым SDT (Structured Document Tag). Аргументы: para_id: paraId абзаца, который нужно обернуть. tag: Уникальное имя тега для элемента управления. control_type: Одно из значений: text|checkbox|dropdown|date. label: Необязательная отображаемая подпись (w:alias). options: Список строк-вариантов для элементов управления типа dropdown. default: Текст по умолчанию (или строка даты для элементов управления типа date).

Параметры

  • para_idstringобязательный
  • tagstringобязательный
  • control_typestringобязательный
  • labelstring
  • optionsany
  • defaultstring
add_cross_reference

Добавьте перекрёстную ссылку из одного абзаца в другой.

Добавьте перекрёстную ссылку из одного абзаца в другой.

Параметры

  • source_para_idstringобязательный
  • target_para_idstringобязательный
  • textstringобязательный
  • document_handlestring
add_endnote

Добавьте концевую сноску к абзацу.

Добавьте концевую сноску к абзацу.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • document_handlestring
add_equation

Вставляет уравнение LaTeX в формате OMML. Требуется: pip install latex2mathml. Аргументы: para_id: paraId абзаца, после которого вставляется уравнение. latex: исходная строка LaTeX (например, r"\frac{1}{2}").

Вставляет уравнение LaTeX в формате OMML. Требуется: pip install latex2mathml. Аргументы: para_id: paraId абзаца, после которого вставляется уравнение. latex: исходная строка LaTeX (например, r"\frac{1}{2}").

Параметры

  • para_idstringобязательный
  • latexstringобязательный
add_field

Вставляет поле Word в конец абзаца. Типовые коды полей: PAGE, NUMPAGES, DATE, SEQ Figure, REF MyBookmark, STYLEREF Heading. Аргументы: para_id: w14:paraId целевого абзаца. field_code: Текст инструкции поля (например, "PAGE"). cached_value: Необязательный отображаемый текст, закешированный в документе.

Вставляет поле Word в конец абзаца. Типовые коды полей: PAGE, NUMPAGES, DATE, SEQ Figure, REF MyBookmark, STYLEREF Heading. Аргументы: para_id: w14:paraId целевого абзаца. field_code: Текст инструкции поля (например, "PAGE"). cached_value: Необязательный отображаемый текст, закешированный в документе.

Параметры

  • para_idstringобязательный
  • field_codestringобязательный
  • cached_valuestring
add_footnote

Добавляет сноску к абзацу. URL, если указан, отображается как гиперссылка.

Добавляет сноску к абзацу. URL, если указан, отображается как гиперссылка.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • urlstring
  • document_handlestring
add_footnote_ref

Добавляет последующую ссылку на существующую сноску без создания нового определения. Используйте, когда один и тот же источник нужно снова процитировать в другом абзаце. Вставляет обёрнутый гиперссылкой footnoteReference, который ведёт к той же сноске, что и исходная цитата. Не дублирует определение сноски в footnotes.xml.

Добавляет последующую ссылку на существующую сноску без создания нового определения. Используйте, когда один и тот же источник нужно снова процитировать в другом абзаце. Вставляет обёрнутый гиперссылкой footnoteReference, который ведёт к той же сноске, что и исходная цитата. Не дублирует определение сноски в footnotes.xml.

Параметры

  • para_idstringобязательный
  • footnote_idintegerобязательный
  • document_handlestring
add_hyperlink

Добавляет внешнюю гиперссылку в конец абзаца. Создает запись отношения в word/_rels/document.xml.rels и элемент w:hyperlink с run-элементом, оформленным стилем Hyperlink, в word/document.xml. Args: para_id: w14:paraId целевого абзаца. text: Отображаемый текст гиперссылки. url: URL, на который указывает гиперссылка.

Добавляет внешнюю гиперссылку в конец абзаца. Создает запись отношения в word/_rels/document.xml.rels и элемент w:hyperlink с run-элементом, оформленным стилем Hyperlink, в word/document.xml. Args: para_id: w14:paraId целевого абзаца. text: Отображаемый текст гиперссылки. url: URL, на который указывает гиперссылка.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • urlstringобязательный
add_internal_link

Добавить внутреннюю якорную гиперссылку (w:anchor) в конец абзаца. Внутренние ссылки обращаются к закладкам по имени и НЕ добавляют отношение. Аргументы: para_id: w14:paraId целевого абзаца. text: Текст, отображаемый для гиперссылки. bookmark: Имя закладки, на которую ведет ссылка.

Добавить внутреннюю якорную гиперссылку (w:anchor) в конец абзаца. Внутренние ссылки обращаются к закладкам по имени и НЕ добавляют отношение. Аргументы: para_id: w14:paraId целевого абзаца. text: Текст, отображаемый для гиперссылки. bookmark: Имя закладки, на которую ведет ссылка.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • bookmarkstringобязательный
add_list

Примените форматирование списка к абзацам (маркированного или нумерованного).

Примените форматирование списка к абзацам (маркированного или нумерованного).

Параметры

  • para_idsstring[]обязательный
  • stylestring
  • document_handlestring
add_page_break

Вставьте разрыв страницы после абзаца.

Вставьте разрыв страницы после абзаца.

Параметры

  • para_idstringобязательный
  • document_handlestring
add_section_break

Добавьте разрыв раздела в абзаце. break_type: nextPage/continuous/evenPage/oddPage.

Добавьте разрыв раздела в абзаце. break_type: nextPage/continuous/evenPage/oddPage.

Параметры

  • para_idstringобязательный
  • break_typestring
  • document_handlestring
add_table

Вставьте новую таблицу после абзаца с отслеженной вставкой.

Вставьте новую таблицу после абзаца с отслеженной вставкой.

Параметры

  • para_idstringобязательный
  • rowsintegerобязательный
  • colsintegerобязательный
  • authorstring
  • document_handlestring
add_table_row

Добавляет строку в таблицу с отслеживанием вставки. row_idx=-1 добавляет в конец.

Добавляет строку в таблицу с отслеживанием вставки. row_idx=-1 добавляет в конец.

Параметры

  • table_idxintegerобязательный
  • row_idxinteger
  • cellsany
  • authorstring
  • document_handlestring
apply_style_to_range

Применяет стиль к списку абзацев по их paraIds. Аргументы: para_ids: Список paraIds абзацев для обновления. style_name_or_id: Название стиля или styleId для применения. Возвращает: {"applied": int, "style_id": str, "para_ids": list[str]}

Применяет стиль к списку абзацев по их paraIds. Аргументы: para_ids: Список paraIds абзацев для обновления. style_name_or_id: Название стиля или styleId для применения. Возвращает: {"applied": int, "style_id": str, "para_ids": list[str]}

Параметры

  • para_idsstring[]обязательный
  • style_name_or_idstringобязательный
audit_document

Проведите комплексный структурный аудит документа.

Проведите комплексный структурный аудит документа.

Параметры

  • document_handlestring
bates_number

Добавляет штамп с нумерацией Бейтса в нижний колонтитул документа. Аргументы: prefix: строка префикса Бейтса (например, "ACME-"). start: начальный номер Бейтса. digits: ширина с дополнением нулями для номера. position: подсказка для положения штампа (сейчас "footer-right").

Добавляет штамп с нумерацией Бейтса в нижний колонтитул документа. Аргументы: prefix: строка префикса Бейтса (например, "ACME-"). start: начальный номер Бейтса. digits: ширина с дополнением нулями для номера. position: подсказка для положения штампа (сейчас "footer-right").

Параметры

  • prefixstringобязательный
  • startinteger
  • digitsinteger
  • positionstring
check_accessibility

Сканирует документ на наличие проблем доступности. Проверяет изображения на отсутствие alt-текста, а таблицы — на отсутствие строк заголовков. Возвращает: {"issue_count": int, "issues": list[dict]}

Сканирует документ на наличие проблем доступности. Проверяет изображения на отсутствие alt-текста, а таблицы — на отсутствие строк заголовков. Возвращает: {"issue_count": int, "issues": list[dict]}

Параметры

Без параметров.

clear_run_formatting

Удаляет всё символьное форматирование из run, заставляя его унаследовать умолчания абзаца/стиля. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс run с нуля.

Удаляет всё символьное форматирование из run, заставляя его унаследовать умолчания абзаца/стиля. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс run с нуля.

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
close_document

Закрывает документ и очищает временные файлы. Аргументы: document_handle: Дескриптор закрываемого документа. Если не указан — используется слот `__default__`.

Закрывает документ и очищает временные файлы. Аргументы: document_handle: Дескриптор закрываемого документа. Если не указан — используется слот `__default__`.

Параметры

  • document_handlestring
compare_contracts

Сравнение с учетом пунктов между открытым контрактом и другим .docx файлом.

Сравнение с учетом пунктов между открытым контрактом и другим .docx файлом.

Параметры

  • other_pathstringобязательный
  • output_pathstring
  • align_bystring
compare_documents

Сравнивает два DOCX файла и создаёт документ с отслеживанием изменений. Поабзацное LCS-сравнение: - Неизменённые абзацы копируются дословно. - Удалённые абзацы (есть в базовом документе, отсутствуют в изменённом) оборачиваются в w:del. - Вставленные абзацы (есть в изменённом, отсутствуют в базовом) оборачиваются в w:ins. - Изменённые абзацы (замена 1:1) получают посимвольное del+ins внутри. Результат — валидный DOCX, открываемый в Word/LibreOffice, с отображением изменений в виде отслеженных правок. Аргументы: base_path: Путь к исходному DOCX. revised_path: Путь к изменённому DOCX. output_path: Путь для сохранения результата. Автоматически генерируется, если пустой.

Сравнивает два DOCX файла и создаёт документ с отслеживанием изменений. Поабзацное LCS-сравнение: - Неизменённые абзацы копируются дословно. - Удалённые абзацы (есть в базовом документе, отсутствуют в изменённом) оборачиваются в w:del. - Вставленные абзацы (есть в изменённом, отсутствуют в базовом) оборачиваются в w:ins. - Изменённые абзацы (замена 1:1) получают посимвольное del+ins внутри. Результат — валидный DOCX, открываемый в Word/LibreOffice, с отображением изменений в виде отслеженных правок. Аргументы: base_path: Путь к исходному DOCX. revised_path: Путь к изменённому DOCX. output_path: Путь для сохранения результата. Автоматически генерируется, если пустой.

Параметры

  • base_pathstringобязательный
  • revised_pathstringобязательный
  • output_pathstring
convert_to_pdf

Конвертирует открытый документ в PDF с помощью LibreOffice в фоновом режиме. Требует установленного LibreOffice ('libreoffice' или 'soffice' в PATH). Аргументы: output_path: Путь для сохранения выходного PDF-файла. Возвращает: {"pdf_path": строка}

Конвертирует открытый документ в PDF с помощью LibreOffice в фоновом режиме. Требует установленного LibreOffice ('libreoffice' или 'soffice' в PATH). Аргументы: output_path: Путь для сохранения выходного PDF-файла. Возвращает: {"pdf_path": строка}

Параметры

  • output_pathstringобязательный
copy_document

Сохраняет полный снимок открытого документа по новому пути. Активная сессия и исходный путь не меняются. Аргументы: output_path: Путь к файлу назначения (должен заканчиваться на .docx). Возвращает: {"copied_to": output_path}

Сохраняет полный снимок открытого документа по новому пути. Активная сессия и исходный путь не меняются. Аргументы: output_path: Путь к файлу назначения (должен заканчиваться на .docx). Возвращает: {"copied_to": output_path}

Параметры

  • output_pathstringобязательный
copy_style

Создаёт глубокую копию существующего стиля под новым именем. Аргументы: source_name_or_id: Имя или styleId стиля, который нужно скопировать. new_name: Имя для нового стиля (пробелы удаляются для styleId). Возвращает: {"style_id": str, "name": str, "type": str}

Создаёт глубокую копию существующего стиля под новым именем. Аргументы: source_name_or_id: Имя или styleId стиля, который нужно скопировать. new_name: Имя для нового стиля (пробелы удаляются для styleId). Возвращает: {"style_id": str, "name": str, "type": str}

Параметры

  • source_name_or_idstringобязательный
  • new_namestringобязательный
copy_table

Глубоко копирует таблицу и вставляет копию сразу после оригинала. Args: table_idx: индекс таблицы, начиная с 0. Returns: {"source_index": int, "new_index": int}

Глубоко копирует таблицу и вставляет копию сразу после оригинала. Args: table_idx: индекс таблицы, начиная с 0. Returns: {"source_index": int, "new_index": int}

Параметры

  • table_idxintegerобязательный
create_document

Создаёт новый пустой .docx документ (или на основе .dotx шаблона). Документ автоматически открывается для редактирования под заданным дескриптором. Используйте save_document, чтобы сохранить изменения, или начинайте редактирование сразу — вставляйте текст, добавляйте таблицы и т.д. Параметры: output_path: Путь к новому .docx файлу. template_path: Необязательный путь к .dotx шаблону. document_handle: Необязательный дескриптор для сохранения этого документа.

Создаёт новый пустой .docx документ (или на основе .dotx шаблона). Документ автоматически открывается для редактирования под заданным дескриптором. Используйте save_document, чтобы сохранить изменения, или начинайте редактирование сразу — вставляйте текст, добавляйте таблицы и т.д. Параметры: output_path: Путь к новому .docx файлу. template_path: Необязательный путь к .dotx шаблону. document_handle: Необязательный дескриптор для сохранения этого документа.

Параметры

  • output_pathstringобязательный
  • template_pathany
  • document_handlestring
create_from_markdown

Создаёт новый документ .docx из содержимого в формате Markdown. Поддерживает полный синтаксис GitHub-Flavored Markdown: заголовки, жирный/курсив/зачёркивание, ссылки, изображения, маркированные/нумерованные/вложенные списки, блоки кода, цитаты, таблицы, сноски и списки задач. Умная типографика (кавычки-ёлочки, длинное и короткое тире, многоточие) применяется автоматически. Укажите ровно один из параметров: `md_path` или `markdown`. Созданный документ автоматически открывается для редактирования под указанным дескриптором. Аргументы: output_path: Путь к новому файлу .docx. md_path: Путь к файлу .md. Взаимоисключающий с `markdown`. markdown: Сырой текст Markdown. Взаимоисключающий с `md_path`. template_path: Необязательный путь к файлу шаблона .dotx. document_handle: Необязательный дескриптор для сохранения этого документа.

Создаёт новый документ .docx из содержимого в формате Markdown. Поддерживает полный синтаксис GitHub-Flavored Markdown: заголовки, жирный/курсив/зачёркивание, ссылки, изображения, маркированные/нумерованные/вложенные списки, блоки кода, цитаты, таблицы, сноски и списки задач. Умная типографика (кавычки-ёлочки, длинное и короткое тире, многоточие) применяется автоматически. Укажите ровно один из параметров: `md_path` или `markdown`. Созданный документ автоматически открывается для редактирования под указанным дескриптором. Аргументы: output_path: Путь к новому файлу .docx. md_path: Путь к файлу .md. Взаимоисключающий с `markdown`. markdown: Сырой текст Markdown. Взаимоисключающий с `md_path`. template_path: Необязательный путь к файлу шаблона .dotx. document_handle: Необязательный дескриптор для сохранения этого документа.

Параметры

  • output_pathstringобязательный
  • md_pathany
  • markdownany
  • template_pathany
  • document_handlestring
create_multilevel_list

Создай многоуровневый список в numbering.xml. Каждый уровень — словарь: {num_fmt, lvl_text, indent, hanging, style?}.

Создай многоуровневый список в numbering.xml. Каждый уровень — словарь: {num_fmt, lvl_text, indent, hanging, style?}.

Параметры

  • namestringобязательный
  • levelsobject[]обязательный
create_style

Создаёт новый стиль в документе. Аргументы: name: Имя стиля (используется как styleId после удаления пробелов). style_type: "paragraph", "character", "table" или "numbering". based_on: Необязательный styleId, от которого наследуется этот стиль. next_style: Необязательный styleId, применяемый к следующему абзацу.

Создаёт новый стиль в документе. Аргументы: name: Имя стиля (используется как styleId после удаления пробелов). style_type: "paragraph", "character", "table" или "numbering". based_on: Необязательный styleId, от которого наследуется этот стиль. next_style: Необязательный styleId, применяемый к следующему абзацу.

Параметры

  • namestringобязательный
  • style_typestringобязательный
  • based_onany
  • next_styleany
csv_to_table

Вставьте таблицу из текста CSV.

Вставьте таблицу из текста CSV.

Параметры

  • para_idstringобязательный
  • csv_textstringобязательный
  • header_rowboolean
delete_column_from_table

Удаляет столбец (индексация с нуля) из каждой строки таблицы.

Удаляет столбец (индексация с нуля) из каждой строки таблицы.

Параметры

  • table_idxintegerобязательный
  • col_idxintegerобязательный
delete_comment

Удаляет комментарий и убирает его маркеры диапазона из документа. Аргументы: comment_id: ID удаляемого комментария.

Удаляет комментарий и убирает его маркеры диапазона из документа. Аргументы: comment_id: ID удаляемого комментария.

Параметры

  • comment_idintegerобязательный
delete_content_control

Удаляет обёртку элемента управления содержимым SDT, оставляя его содержимое на месте. Args: control_id: Значение w:id элемента управления содержимым, для которого нужно снять обёртку.

Удаляет обёртку элемента управления содержимым SDT, оставляя его содержимое на месте. Args: control_id: Значение w:id элемента управления содержимым, для которого нужно снять обёртку.

Параметры

  • control_idstringобязательный
delete_custom_property

Удалить пользовательское свойство документа по имени. Аргументы: name: Имя свойства для удаления.

Удалить пользовательское свойство документа по имени. Аргументы: name: Имя свойства для удаления.

Параметры

  • namestringобязательный
delete_endnote

Удаляет концевую сноску и ссылку на неё в тексте. Удаляет определение концевой сноски из endnotes.xml и удаляет run endnoteReference из основного текста документа. Аргументы: endnote_id: Числовой идентификатор удаляемой концевой сноски.

Удаляет концевую сноску и ссылку на неё в тексте. Удаляет определение концевой сноски из endnotes.xml и удаляет run endnoteReference из основного текста документа. Аргументы: endnote_id: Числовой идентификатор удаляемой концевой сноски.

Параметры

  • endnote_idintegerобязательный
delete_field

Удалить полное комплексное поле (от начала до конца) из документа. Аргументы: field_id: позиционный идентификатор, возвращаемый list_fields (например, "field_0").

Удалить полное комплексное поле (от начала до конца) из документа. Аргументы: field_id: позиционный идентификатор, возвращаемый list_fields (например, "field_0").

Параметры

  • field_idstringобязательный
delete_footer

Удалить колонтитул по местоположению: по умолчанию, первый или чётный.

Удалить колонтитул по местоположению: по умолчанию, первый или чётный.

Параметры

  • locationstring
delete_footnote

Удаляет сноску и её ссылку в теле документа. Удаляет определение сноски из footnotes.xml и удаляет элемент footnoteReference из тела документа. Аргументы: footnote_id: Числовой идентификатор удаляемой сноски.

Удаляет сноску и её ссылку в теле документа. Удаляет определение сноски из footnotes.xml и удаляет элемент footnoteReference из тела документа. Аргументы: footnote_id: Числовой идентификатор удаляемой сноски.

Параметры

  • footnote_idintegerобязательный
delete_header

Удалить заголовок по расположению: по умолчанию, первый или чётный.

Удалить заголовок по расположению: по умолчанию, первый или чётный.

Параметры

  • locationstring
delete_image

Удаляет рисунок, содержащий изображение с указанным rId, из документа. Также удаляет запись отношения из word/_rels/document.xml.rels. Args: rId: Идентификатор отношения удаляемого изображения (например, 'rId5').

Удаляет рисунок, содержащий изображение с указанным rId, из документа. Также удаляет запись отношения из word/_rels/document.xml.rels. Args: rId: Идентификатор отношения удаляемого изображения (например, 'rId5').

Параметры

  • rIdstringобязательный
delete_paragraph

Удаляет параграф с указанным paraId. Аргументы: para_id: paraId параграфа, который нужно удалить.

Удаляет параграф с указанным paraId. Аргументы: para_id: paraId параграфа, который нужно удалить.

Параметры

  • para_idstringобязательный
delete_section_break

Удаляет разрыв раздела из абзаца. Удаляет w:sectPr из w:pPr абзаца. После удаления содержимое абзаца перетекает в следующий раздел, а не завершает текущий. Аргументы: para_id: paraId абзаца, в котором находится разрыв раздела. Исключения: ValueError: если в абзаце нет разрыва раздела.

Удаляет разрыв раздела из абзаца. Удаляет w:sectPr из w:pPr абзаца. После удаления содержимое абзаца перетекает в следующий раздел, а не завершает текущий. Аргументы: para_id: paraId абзаца, в котором находится разрыв раздела. Исключения: ValueError: если в абзаце нет разрыва раздела.

Параметры

  • para_idstringобязательный
delete_style

Удаляет стиль из документа. Аргументы: name: имя стиля или styleId (без учёта регистра).

Удаляет стиль из документа. Аргументы: name: имя стиля или styleId (без учёта регистра).

Параметры

  • namestringобязательный
delete_table

Удаляет таблицу по индексу (счёт с нуля). Вызывает IndexError, если индекс выходит за пределы диапазона.

Удаляет таблицу по индексу (счёт с нуля). Вызывает IndexError, если индекс выходит за пределы диапазона.

Параметры

  • table_idxintegerобязательный
delete_table_row

Удалить строку таблицы с отслеживаемыми изменениями.

Удалить строку таблицы с отслеживаемыми изменениями.

Параметры

  • table_idxintegerобязательный
  • row_idxintegerобязательный
  • authorstring
  • document_handlestring
delete_text

Удаляет текст из параграфа. Находит текст внутри параграфа (при необходимости — через границы прогонов). При tracked=True (по умолчанию) удалённый текст остаётся видимым красным зачёркиванием в режиме отслеживания изменений Word — человек-рецензент должен принять удаление, чтобы убрать его навсегда. При tracked=False текст удаляется немедленно. Укажите context_before/context_after, чтобы устранить неоднозначность, если один и тот же текст встречается несколько раз или содержит умные кавычки / особые пробелы. Аргументы: para_id: Идентификатор целевого параграфа. text: Текст для удаления (ASCII-кавычки/дефисы/пробелы сопоставляются с их Unicode-эквивалентами). author: Имя автора, отображаемое в панели рецензирования Word (только при tracked=True). context_before: Текст непосредственно перед целевым фрагментом (для точной привязки). context_after: Текст сразу после целевого фрагмента (для точной привязки). ignore_case: Если True, искать текст и контекст без учёта регистра. tracked: True (по умолчанию) — красное зачёркивание, которое человек принимает или отклоняет. False — текст удаляется сразу, без разметки. document_handle: Необязательный дескриптор для изоляции одновременных сессий.

Удаляет текст из параграфа. Находит текст внутри параграфа (при необходимости — через границы прогонов). При tracked=True (по умолчанию) удалённый текст остаётся видимым красным зачёркиванием в режиме отслеживания изменений Word — человек-рецензент должен принять удаление, чтобы убрать его навсегда. При tracked=False текст удаляется немедленно. Укажите context_before/context_after, чтобы устранить неоднозначность, если один и тот же текст встречается несколько раз или содержит умные кавычки / особые пробелы. Аргументы: para_id: Идентификатор целевого параграфа. text: Текст для удаления (ASCII-кавычки/дефисы/пробелы сопоставляются с их Unicode-эквивалентами). author: Имя автора, отображаемое в панели рецензирования Word (только при tracked=True). context_before: Текст непосредственно перед целевым фрагментом (для точной привязки). context_after: Текст сразу после целевого фрагмента (для точной привязки). ignore_case: Если True, искать текст и контекст без учёта регистра. tracked: True (по умолчанию) — красное зачёркивание, которое человек принимает или отклоняет. False — текст удаляется сразу, без разметки. document_handle: Необязательный дескриптор для изоляции одновременных сессий.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • authorstring
  • context_beforestring
  • context_afterstring
  • ignore_caseboolean
  • trackedboolean
  • document_handlestring
demote_list_item

Увеличивает уровень отступа списка (ilvl) абзаца на 1, максимум 8. Возвращает {para_id, ilvl}. Вызывает ValueError, если абзац не является элементом списка.

Увеличивает уровень отступа списка (ilvl) абзаца на 1, максимум 8. Возвращает {para_id, ilvl}. Вызывает ValueError, если абзац не является элементом списка.

Параметры

  • para_idstringобязательный
diff_to_text

Сравнивает два отдельных DOCX-файла и создаёт DOCX с отслеживанием изменений плюс текстовую сводку. Используйте это, когда у вас есть два разных файла (например, оригинал и исправленная копия) и нужно показать, что изменилось между ними. Создаёт: 1. DOCX с разметкой отслеженных изменений (удаления красным, вставки подчёркиванием). 2. Текстовую сводку .txt, подходящую для вставки в письмо или описание pull-request. Если вы уже внесли отслеживаемые правки в открытый в данный момент документ и просто хотите получить сводку этих изменений, используйте generate_change_summary. Аргументы: base_path — путь к исходному DOCX-файлу. revised_path — путь к изменённому DOCX-файлу. docx_output — путь для выходного DOCX-файла с отслеживанием изменений (генерируется автоматически, если не указан). text_output — путь для текстовой сводки .txt (генерируется автоматически, если не указан).

Сравнивает два отдельных DOCX-файла и создаёт DOCX с отслеживанием изменений плюс текстовую сводку. Используйте это, когда у вас есть два разных файла (например, оригинал и исправленная копия) и нужно показать, что изменилось между ними. Создаёт: 1. DOCX с разметкой отслеженных изменений (удаления красным, вставки подчёркиванием). 2. Текстовую сводку .txt, подходящую для вставки в письмо или описание pull-request. Если вы уже внесли отслеживаемые правки в открытый в данный момент документ и просто хотите получить сводку этих изменений, используйте generate_change_summary. Аргументы: base_path — путь к исходному DOCX-файлу. revised_path — путь к изменённому DOCX-файлу. docx_output — путь для выходного DOCX-файла с отслеживанием изменений (генерируется автоматически, если не указан). text_output — путь для текстовой сводки .txt (генерируется автоматически, если не указан).

Параметры

  • base_pathstringобязательный
  • revised_pathstringобязательный
  • docx_outputstring
  • text_outputstring
duplicate_table_row

Глубоко копирует строку таблицы и вставляет копию сразу после неё. Аргументы: table_idx: индекс таблицы (нумерация с 0). row_index: индекс строки для дублирования (нумерация с 0). Возвращает: {"row_index": int, "new_row_index": int}

Глубоко копирует строку таблицы и вставляет копию сразу после неё. Аргументы: table_idx: индекс таблицы (нумерация с 0). row_index: индекс строки для дублирования (нумерация с 0). Возвращает: {"row_index": int, "new_row_index": int}

Параметры

  • table_idxintegerобязательный
  • row_indexintegerобязательный
edit_header_footer

Редактирует текст в колонтитуле. По умолчанию (tracked=True) изменение записывается как удаление старого текста и вставка нового — человек проверяющий принимает или отклоняет их в Word. Передайте tracked=False, чтобы заменить текст напрямую, без пометок исправлений. Аргументы: location: "header" или "footer" (подбирает первый найденный колонтитул этого типа). old_text: Текст для поиска и замены. new_text: Текст для замены. author: Имя автора, которое отображается в панели проверки Word (только при tracked=True). tracked: True (по умолчанию) = отслеживаемое удаление+вставка. False = прямая замена, без пометок. document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Редактирует текст в колонтитуле. По умолчанию (tracked=True) изменение записывается как удаление старого текста и вставка нового — человек проверяющий принимает или отклоняет их в Word. Передайте tracked=False, чтобы заменить текст напрямую, без пометок исправлений. Аргументы: location: "header" или "footer" (подбирает первый найденный колонтитул этого типа). old_text: Текст для поиска и замены. new_text: Текст для замены. author: Имя автора, которое отображается в панели проверки Word (только при tracked=True). tracked: True (по умолчанию) = отслеживаемое удаление+вставка. False = прямая замена, без пометок. document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Параметры

  • locationstringобязательный
  • old_textstringобязательный
  • new_textstringобязательный
  • authorstring
  • trackedboolean
  • document_handlestring
export_markdown

Экспортирует открытый документ как Markdown. Преобразует тело документа (заголовки, жирный/курсивный текст, списки, таблицы, обычные абзацы) в GitHub-Flavoured Markdown и записывает в файл. Аргументы: output_path: путь к файлу .md для записи. По умолчанию <workdir>/export.md, если не указан. Возвращает: {"output_path": str, "paragraphs": int, "tables": int}

Экспортирует открытый документ как Markdown. Преобразует тело документа (заголовки, жирный/курсивный текст, списки, таблицы, обычные абзацы) в GitHub-Flavoured Markdown и записывает в файл. Аргументы: output_path: путь к файлу .md для записи. По умолчанию <workdir>/export.md, если не указан. Возвращает: {"output_path": str, "paragraphs": int, "tables": int}

Параметры

  • output_pathstring
export_session_script

Запишите операции сессии в виде скрипта воспроизведения на Python. Возвращает: {"output_path": str, "operations": int}

Запишите операции сессии в виде скрипта воспроизведения на Python. Возвращает: {"output_path": str, "operations": int}

Параметры

  • output_pathstringобязательный
fill_template

Заполняет элементы управления содержимым SDT из словаря данных. Ключи совпадают со значениями w:tag. Аргументы: data: соответствие имён тегов значениям. Используйте list[str] для повторяющихся секций. remove_empty: если True, удаляет SDT, для которых нет подходящего ключа в data.

Заполняет элементы управления содержимым SDT из словаря данных. Ключи совпадают со значениями w:tag. Аргументы: data: соответствие имён тегов значениям. Используйте list[str] для повторяющихся секций. remove_empty: если True, удаляет SDT, для которых нет подходящего ключа в data.

Параметры

  • dataobjectобязательный
  • remove_emptyboolean
find_replace_formatted

Находит все вхождения строки и заменяет их форматированным текстом. Заменяет каждое вхождение `find` во всех абзацах документа на `replace`, применяя указанное форматирование символов только к заменённому фрагменту. Аргументы: - find: Текст для поиска (не может быть пустым). - replace: Текст для замены. - bold: True (сделать жирным), False (явно убрать жирность), None (оставить без изменений). - italic: True (курсив), False (явно убрать курсив), None (оставить без изменений). - color: Цвет шрифта в 6-значном шестнадцатеричном формате (например, "FF0000"). None — цвет не меняется. - size_pt: Размер шрифта в пунктах (например, 12.0). None — размер не меняется.

Находит все вхождения строки и заменяет их форматированным текстом. Заменяет каждое вхождение `find` во всех абзацах документа на `replace`, применяя указанное форматирование символов только к заменённому фрагменту. Аргументы: - find: Текст для поиска (не может быть пустым). - replace: Текст для замены. - bold: True (сделать жирным), False (явно убрать жирность), None (оставить без изменений). - italic: True (курсив), False (явно убрать курсив), None (оставить без изменений). - color: Цвет шрифта в 6-значном шестнадцатеричном формате (например, "FF0000"). None — цвет не меняется. - size_pt: Размер шрифта в пунктах (например, 12.0). None — размер не меняется.

Параметры

  • findstringобязательный
  • replacestringобязательный
  • boldany
  • italicany
  • colorany
  • size_ptany
flatten_document

Принять все отслеживаемые изменения и удалить всю разметку правок. Принимает каждый w:ins / w:del и удаляет все элементы w:rPrChange и w:pPrChange, оставляя обычный текст без метаданных отслеживания изменений. Возвращает: {"changes_accepted": int, "formatting_changes_removed": int}

Принять все отслеживаемые изменения и удалить всю разметку правок. Принимает каждый w:ins / w:del и удаляет все элементы w:rPrChange и w:pPrChange, оставляя обычный текст без метаданных отслеживания изменений. Возвращает: {"changes_accepted": int, "formatting_changes_removed": int}

Параметры

Без параметров.

generate_change_summary

Создаёт сводку отслеженных изменений, уже присутствующих в открытом документе, и сохраняет её в .txt, готовый для отправки по email. Используйте этот инструмент после внесения правок с параметром tracked=True (значение по умолчанию) и сохранения документа, чтобы получить читаемый лог изменений — что именно было модифицировано. Инструмент читает существующие элементы w:ins / w:del документа, группирует соседние пары «удаление + вставка» как записи REPLACEMENT и выводит нумерованный список с автором, датой и текстом каждого изменения. Типичный порядок действий: open_document → edit with tracked=True → save_document → generate_change_summary Если нужно сравнить два отдельных файла, а не уже отредактированный документ, используйте diff_to_text. Аргументы: output_path: Путь для сохранения .txt. Если не указан, автоматически генерируется из имени документа (без расширения). document_handle: Необязательный идентификатор для изоляции одновременных сессий.

Создаёт сводку отслеженных изменений, уже присутствующих в открытом документе, и сохраняет её в .txt, готовый для отправки по email. Используйте этот инструмент после внесения правок с параметром tracked=True (значение по умолчанию) и сохранения документа, чтобы получить читаемый лог изменений — что именно было модифицировано. Инструмент читает существующие элементы w:ins / w:del документа, группирует соседние пары «удаление + вставка» как записи REPLACEMENT и выводит нумерованный список с автором, датой и текстом каждого изменения. Типичный порядок действий: open_document → edit with tracked=True → save_document → generate_change_summary Если нужно сравнить два отдельных файла, а не уже отредактированный документ, используйте diff_to_text. Аргументы: output_path: Путь для сохранения .txt. Если не указан, автоматически генерируется из имени документа (без расширения). document_handle: Необязательный идентификатор для изоляции одновременных сессий.

Параметры

  • output_pathstring
  • document_handlestring
generate_list_of_figures

Вставьте поле списка иллюстраций (требуются подписи рисунков с кодом SEQ).

Вставьте поле списка иллюстраций (требуются подписи рисунков с кодом SEQ).

Параметры

Без параметров.

generate_list_of_tables

Вставьте поле «Список таблиц» (требует подписей таблиц, созданных с помощью SEQ).

Вставьте поле «Список таблиц» (требует подписей таблиц, созданных с помощью SEQ).

Параметры

Без параметров.

generate_privilege_log

Сгенерировать DOCX-файл журнала привилегий на основе метаданных документа. Аргументы: output_path: Путь назначения. Если пусто, записывает во временный файл.

Сгенерировать DOCX-файл журнала привилегий на основе метаданных документа. Аргументы: output_path: Путь назначения. Если пусто, записывает во временный файл.

Параметры

  • output_pathstring
generate_redaction_log

Создайте таблицу DOCX всех правок, сделанных за эту сессию. Args: output_path: Путь назначения. Если пусто, записывает во временный файл.

Создайте таблицу DOCX всех правок, сделанных за эту сессию. Args: output_path: Путь назначения. Если пусто, записывает во временный файл.

Параметры

  • output_pathstring
generate_toc

Создайте оглавление из заголовков документа.

Создайте оглавление из заголовков документа.

Параметры

  • max_levelinteger
  • titlestring
generate_tof

Вставьте блок поля «Список иллюстраций» после абзаца с para_id. Собирает абзацы в стиле подписи, начинающиеся со слова «Figure», в качестве записей.

Вставьте блок поля «Список иллюстраций» после абзаца с para_id. Собирает абзацы в стиле подписи, начинающиеся со слова «Figure», в качестве записей.

Параметры

  • para_idstringобязательный
  • titlestring
generate_tot

Вставьте блок полей «Таблица таблиц» после абзаца с para_id. Собирает абзацы в стиле подписей, начинающиеся с «Table», в качестве записей.

Вставьте блок полей «Таблица таблиц» после абзаца с para_id. Собирает абзацы в стиле подписей, начинающиеся с «Table», в качестве записей.

Параметры

  • para_idstringобязательный
  • titlestring
get_alt_text

Получить альтернативный текст и заголовок изображения по индексу, начиная с 0. Аргументы: image_index: индекс, начиная с 0, среди всех элементов wp:docPr в document.xml. Возвращает: {"image_index": int, "alt_text": str, "title": str}

Получить альтернативный текст и заголовок изображения по индексу, начиная с 0. Аргументы: image_index: индекс, начиная с 0, среди всех элементов wp:docPr в document.xml. Возвращает: {"image_index": int, "alt_text": str, "title": str}

Параметры

  • image_indexintegerобязательный
get_body_text

Возвращает полный текст документа в принятом представлении (accepted view). Принятое представление: текст внутри w:ins включён, текст внутри w:del исключён. Включает текст внутри прогонов w:hyperlink. Абзацы объединяются символом новой строки. Текст сносок возвращается отдельно. Возвращает JSON: {"body": str, "footnotes": str}

Возвращает полный текст документа в принятом представлении (accepted view). Принятое представление: текст внутри w:ins включён, текст внутри w:del исключён. Включает текст внутри прогонов w:hyperlink. Абзацы объединяются символом новой строки. Текст сносок возвращается отдельно. Возвращает JSON: {"body": str, "footnotes": str}

Параметры

  • document_handlestring
get_bookmarked_text

Получить текстовое содержимое в именованной закладке.

Получить текстовое содержимое в именованной закладке.

Параметры

  • namestringобязательный
get_cell_text

Возвращает текстовое содержимое указанной ячейки. Аргументы: table_idx: индекс таблицы (начиная с 0). row_idx: индекс строки (начиная с 0). col_idx: индекс столбца (начиная с 0). Результат: {"table_index": int, "row_index": int, "col_index": int, "text": str}

Возвращает текстовое содержимое указанной ячейки. Аргументы: table_idx: индекс таблицы (начиная с 0). row_idx: индекс строки (начиная с 0). col_idx: индекс столбца (начиная с 0). Результат: {"table_index": int, "row_index": int, "col_index": int, "text": str}

Параметры

  • table_idxintegerобязательный
  • row_idxintegerобязательный
  • col_idxintegerобязательный
get_comments

Выведи все комментарии с их ID, автором, датой и текстом.

Выведи все комментарии с их ID, автором, датой и текстом.

Параметры

  • document_handlestring
get_content_control

Возвращает детали одного элемента управления содержимым по его w:id. Аргументы: control_id: Значение w:id элемента управления содержимым, который нужно получить.

Возвращает детали одного элемента управления содержимым по его w:id. Аргументы: control_id: Значение w:id элемента управления содержимым, который нужно получить.

Параметры

  • control_idstringобязательный
get_content_controls

Перечисли все элементы управления содержимым SDT в документе.

Перечисли все элементы управления содержимым SDT в документе.

Параметры

Без параметров.

get_custom_properties

Получите пользовательские свойства документа из docProps/custom.xml.

Получите пользовательские свойства документа из docProps/custom.xml.

Параметры

Без параметров.

get_document_info

Получить общую статистику: количество абзацев, заголовков, сносок, комментариев, изображений.

Получить общую статистику: количество абзацев, заголовков, сносок, комментариев, изображений.

Параметры

  • document_handlestring
get_document_outline

Возвращает плоский список заголовков в виде структуры документа. Проходит по телу документа и возвращает каждый абзац-заголовок до указанного уровня. Аргументы: max_level: Максимальный уровень заголовка для включения (1–6, по умолчанию 6). Возвращает: JSON-список словарей с ключами: level (int), text (str), para_id (str).

Возвращает плоский список заголовков в виде структуры документа. Проходит по телу документа и возвращает каждый абзац-заголовок до указанного уровня. Аргументы: max_level: Максимальный уровень заголовка для включения (1–6, по умолчанию 6). Возвращает: JSON-список словарей с ключами: level (int), text (str), para_id (str).

Параметры

  • max_levelinteger
get_endnotes

Получить все концевые сноски с их ID и текстовым содержимым.

Получить все концевые сноски с их ID и текстовым содержимым.

Параметры

  • document_handlestring
get_equations

Вернуть все уравнения из документа в виде строк OMML XML.

Вернуть все уравнения из документа в виде строк OMML XML.

Параметры

Без параметров.

get_field

Возвращает подробности одного поля по field_id. Аргументы: field_id: Позиционный идентификатор, возвращаемый list_fields (например, "field_0").

Возвращает подробности одного поля по field_id. Аргументы: field_id: Позиционный идентификатор, возвращаемый list_fields (например, "field_0").

Параметры

  • field_idstringобязательный
get_footnotes

Выведи список всех сносок с их ID и текстовым содержанием.

Выведи список всех сносок с их ID и текстовым содержанием.

Параметры

  • document_handlestring
get_headers_footers

Получите все верхние и нижние колонтитулы вместе с их текстовым содержимым.

Получите все верхние и нижние колонтитулы вместе с их текстовым содержимым.

Параметры

  • document_handlestring
get_headings

Получает структуру заголовков документа с уровнями, текстом и paraId. Возвращает список заголовков в порядке документа, каждый содержит: - level (1-9) - text (содержимое заголовка) - style (например, "Heading1") - paraId (уникальный идентификатор абзаца для точного редактирования)

Получает структуру заголовков документа с уровнями, текстом и paraId. Возвращает список заголовков в порядке документа, каждый содержит: - level (1-9) - text (содержимое заголовка) - style (например, "Heading1") - paraId (уникальный идентификатор абзаца для точного редактирования)

Параметры

  • document_handlestring
get_images

Получить все встроенные изображения с rId, именем файла, типом содержимого и размерами.

Получить все встроенные изображения с rId, именем файла, типом содержимого и размерами.

Параметры

  • document_handlestring
get_lists

Возвращает все определения списков из numbering.xml. Каждая запись: {abstract_num_id, num_format, levels}. Возвращает [], если numbering.xml не существует.

Возвращает все определения списков из numbering.xml. Каждая запись: {abstract_num_id, num_format, levels}. Возвращает [], если numbering.xml не существует.

Параметры

Без параметров.

get_paragraph

Получить полный текст и стиль конкретного абзаца по его paraId. Аргументы: para_id: 8-символьный шестнадцатеричный paraId (например, "1A2B3C4D").

Получить полный текст и стиль конкретного абзаца по его paraId. Аргументы: para_id: 8-символьный шестнадцатеричный paraId (например, "1A2B3C4D").

Параметры

  • para_idstringобязательный
  • document_handlestring
get_paragraph_format

Читает все атрибуты форматирования абзаца. Возвращает стиль, выравнивание, отступы, межстрочный интервал, границу, заливку и информацию о списке. Аргументы: para_id: paraId целевого абзаца.

Читает все атрибуты форматирования абзаца. Возвращает стиль, выравнивание, отступы, межстрочный интервал, границу, заливку и информацию о списке. Аргументы: para_id: paraId целевого абзаца.

Параметры

  • para_idstringобязательный
get_properties

Получить основные свойства документа (название, автор, тема, даты, редакция).

Получить основные свойства документа (название, автор, тема, даты, редакция).

Параметры

  • document_handlestring
get_reading_time

Оценивает время чтения открытого документа. Аргументы: words_per_minute: Предполагаемая скорость чтения (по умолчанию 200 слов/мин). Возвращает: {"word_count": int, "words_per_minute": int, "minutes": float, "seconds": int}

Оценивает время чтения открытого документа. Аргументы: words_per_minute: Предполагаемая скорость чтения (по умолчанию 200 слов/мин). Возвращает: {"word_count": int, "words_per_minute": int, "minutes": float, "seconds": int}

Параметры

  • words_per_minuteinteger
get_runs

Получить все runs в абзаце с их свойствами форматирования. Аргументы: para_id: идентификатор целевого абзаца (paraId).

Получить все runs в абзаце с их свойствами форматирования. Аргументы: para_id: идентификатор целевого абзаца (paraId).

Параметры

  • para_idstringобязательный
get_sections

Перечислить все разделы в документе с их свойствами. Возвращает JSON-массив объектов разделов, каждый из которых содержит: index, break_type, page_width, page_height, orientation, columns, margin_top, margin_bottom (все размеры в twips/DXA). Последний раздел всегда имеет break_type="".

Перечислить все разделы в документе с их свойствами. Возвращает JSON-массив объектов разделов, каждый из которых содержит: index, break_type, page_width, page_height, orientation, columns, margin_top, margin_bottom (все размеры в twips/DXA). Последний раздел всегда имеет break_type="".

Параметры

Без параметров.

get_session_log

Вернуть все операции, выполненные за эту сессию, в виде воспроизводимого JSON.

Вернуть все операции, выполненные за эту сессию, в виде воспроизводимого JSON.

Параметры

Без параметров.

get_statistics

Возвращает статистику для открытого документа. Возвращает словарь с ключами: word_count, character_count, paragraph_count, table_count, image_count, section_count.

Возвращает статистику для открытого документа. Возвращает словарь с ключами: word_count, character_count, paragraph_count, table_count, image_count, section_count.

Параметры

Без параметров.

get_style

Получает подробности об одном стиле по имени или styleId (без учёта регистра). Аргументы: name_or_id: Имя стиля или styleId для поиска. Возвращает: {"style_id": str, "name": str, "type": str, "base_style": str, "next_style": str}

Получает подробности об одном стиле по имени или styleId (без учёта регистра). Аргументы: name_or_id: Имя стиля или styleId для поиска. Возвращает: {"style_id": str, "name": str, "type": str, "base_style": str, "next_style": str}

Параметры

  • name_or_idstringобязательный
get_styles

Получите все определенные стили с ID, названием, типом и базовым стилем.

Получите все определенные стили с ID, названием, типом и базовым стилем.

Параметры

  • document_handlestring
get_table

Получить структурированную информацию для одной таблицы по нулевому индексу. Аргументы: table_idx: нулевой индекс таблицы. Возвращает: {"index": int, "row_count": int, "col_count": int, "cells": list[list[str]]}

Получить структурированную информацию для одной таблицы по нулевому индексу. Аргументы: table_idx: нулевой индекс таблицы. Возвращает: {"index": int, "row_count": int, "col_count": int, "cells": list[list[str]]}

Параметры

  • table_idxintegerобязательный
get_tables

Получите все таблицы с количеством строк/столбцов и текстовым содержимым ячеек.

Получите все таблицы с количеством строк/столбцов и текстовым содержимым ячеек.

Параметры

  • document_handlestring
get_theme_colors

Возвращает именованные слоты цветов из word/theme/theme1.xml. Возвращает словарь, сопоставляющий имена слотов (dk1, lt1, accent1, ...) с шестнадцатеричными строками из 6 символов. Возвращает пустой словарь, если в документе нет файла темы.

Возвращает именованные слоты цветов из word/theme/theme1.xml. Возвращает словарь, сопоставляющий имена слотов (dk1, lt1, accent1, ...) с шестнадцатеричными строками из 6 символов. Возвращает пустой словарь, если в документе нет файла темы.

Параметры

Без параметров.

get_tracked_changes

Вернуть все ожидающие отслеживаемые изменения (вставки и удаления) в виде JSON-списка. Каждая запись содержит: type, change_id, author, date, para_id, text. Изменения возвращаются в порядке документа.

Вернуть все ожидающие отслеживаемые изменения (вставки и удаления) в виде JSON-списка. Каждая запись содержит: type, change_id, author, date, para_id, text. Изменения возвращаются в порядке документа.

Параметры

  • document_handlestring
get_word_count

Возвращает количество слов в теле открытого документа. Возвращает: {"word_count": int}

Возвращает количество слов в теле открытого документа. Возвращает: {"word_count": int}

Параметры

Без параметров.

insert_bar_chart

Вставьте встроенную столбчатую диаграмму (Excel не требуется). series: [{"name": str, "values": [float, ...]}]

Вставьте встроенную столбчатую диаграмму (Excel не требуется). series: [{"name": str, "values": [float, ...]}]

Параметры

  • para_idstringобязательный
  • titlestringобязательный
  • seriesobject[]обязательный
  • categoriesstring[]обязательный
  • width_cmnumber
  • height_cmnumber
insert_blockquote

Вставляет абзац с цитатой после указанного абзаца. Новый абзац имеет отступ слева 720 твипов и курсивное форматирование. Аргументы: para_id: идентификатор ссылочного абзаца (новый абзац вставляется после него). text: текст цитаты.

Вставляет абзац с цитатой после указанного абзаца. Новый абзац имеет отступ слева 720 твипов и курсивное форматирование. Аргументы: para_id: идентификатор ссылочного абзаца (новый абзац вставляется после него). text: текст цитаты.

Параметры

  • para_idstringобязательный
  • textstringобязательный
insert_caption

Вставляет абзац подписи после указанного абзаца. Аргументы: after_para_id: paraId абзаца, после которого вставить. text: Текст описания подписи (без префикса метки/номера). label: Метка подписи, например "Figure" или "Table" (по умолчанию "Figure").

Вставляет абзац подписи после указанного абзаца. Аргументы: after_para_id: paraId абзаца, после которого вставить. text: Текст описания подписи (без префикса метки/номера). label: Метка подписи, например "Figure" или "Table" (по умолчанию "Figure").

Параметры

  • after_para_idstringобязательный
  • textstringобязательный
  • labelstring
insert_code_block

Вставляет абзац с блоком кода после указанного абзаца. Новый абзац использует шрифт Courier New 10pt со светло-серым фоном. Аргументы: para_id: Идентификатор paraId исходного абзаца (новый абзац вставляется после него). text: Текст кода. language: Необязательная подсказка о языке (сохраняется только в возвращаемом значении).

Вставляет абзац с блоком кода после указанного абзаца. Новый абзац использует шрифт Courier New 10pt со светло-серым фоном. Аргументы: para_id: Идентификатор paraId исходного абзаца (новый абзац вставляется после него). text: Текст кода. language: Необязательная подсказка о языке (сохраняется только в возвращаемом значении).

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • languagestring
insert_date_field

Вставьте поле DATE в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца. date_format: Переключатель формата даты (по умолчанию: \@ "MMMM d, yyyy").

Вставьте поле DATE в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца. date_format: Переключатель формата даты (по умолчанию: \@ "MMMM d, yyyy").

Параметры

  • para_idstringобязательный
  • date_formatstring
insert_floating_image

Вставить плавающее (привязанное) изображение. wrap: square|topbottom|none.

Вставить плавающее (привязанное) изображение. wrap: square|topbottom|none.

Параметры

  • para_idstringобязательный
  • image_pathstringобязательный
  • width_cmnumberобязательный
  • height_cmnumberобязательный
  • h_posnumber
  • v_posnumber
  • wrapstring
insert_if_field

Вставляет условное поле Word IF в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца. condition: Условное выражение (например, "x > 0"). true_text: Текст, отображаемый при выполнении условия. false_text: Текст, отображаемый при невыполнении условия.

Вставляет условное поле Word IF в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца. condition: Условное выражение (например, "x > 0"). true_text: Текст, отображаемый при выполнении условия. false_text: Текст, отображаемый при невыполнении условия.

Параметры

  • para_idstringобязательный
  • conditionstringобязательный
  • true_textstringобязательный
  • false_textstringобязательный
insert_image

Вставьте изображение в документ после абзаца.

Вставьте изображение в документ после абзаца.

Параметры

  • para_idstringобязательный
  • image_pathstringобязательный
  • width_emuinteger
  • height_emuinteger
  • document_handlestring
insert_line_chart

Вставьте нативный линейный график. series: [{"name": str, "values": [float, ...]}]

Вставьте нативный линейный график. series: [{"name": str, "values": [float, ...]}]

Параметры

  • para_idstringобязательный
  • titlestringобязательный
  • seriesobject[]обязательный
  • categoriesstring[]обязательный
  • width_cmnumber
  • height_cmnumber
insert_merge_field

Вставляет поле MERGEFIELD (слияние почты) в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца. field_name: имя поля слияния (например, "FirstName").

Вставляет поле MERGEFIELD (слияние почты) в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца. field_name: имя поля слияния (например, "FirstName").

Параметры

  • para_idstringобязательный
  • field_namestringобязательный
insert_page_number_field

Вставьте поле PAGE в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца.

Вставьте поле PAGE в конец абзаца. Аргументы: para_id: w14:paraId целевого абзаца.

Параметры

  • para_idstringобязательный
insert_paragraph

Вставляет новый абзац после абзаца с указанным paraId. Аргументы: after_para_id: paraId абзаца, после которого нужно вставить. text: Текстовое содержимое нового абзаца. style: Необязательное имя стиля абзаца (например, "Heading1", "Normal").

Вставляет новый абзац после абзаца с указанным paraId. Аргументы: after_para_id: paraId абзаца, после которого нужно вставить. text: Текстовое содержимое нового абзаца. style: Необязательное имя стиля абзаца (например, "Heading1", "Normal").

Параметры

  • after_para_idstringобязательный
  • textstringобязательный
  • stylestring
insert_pie_chart

Вставьте нативную круговую диаграмму (один ряд данных, фиксированный размер 14×9 см). series: [{"name": str, "values": [float, ...]}]

Вставьте нативную круговую диаграмму (один ряд данных, фиксированный размер 14×9 см). series: [{"name": str, "values": [float, ...]}]

Параметры

  • para_idstringобязательный
  • titlestringобязательный
  • seriesobject[]обязательный
  • categoriesstring[]обязательный
insert_sequence_field

Вставляет поле SEQ (последовательность) для нумерации рисунков/таблиц. Аргументы: para_id: w14:paraId целевого абзаца. seq_name: Идентификатор последовательности (например, "Figure", "Table"). reset: Если True, перезапускает счётчик последовательности с 1.

Вставляет поле SEQ (последовательность) для нумерации рисунков/таблиц. Аргументы: para_id: w14:paraId целевого абзаца. seq_name: Идентификатор последовательности (например, "Figure", "Table"). reset: Если True, перезапускает счётчик последовательности с 1.

Параметры

  • para_idstringобязательный
  • seq_namestringобязательный
  • resetboolean
insert_text

Вставляет текст в абзац. По умолчанию (tracked=True) вставка отмечается как предлагаемое дополнение — оно отображается подчеркнутым в режиме отслеживания изменений Word. Ответственный за проверку должен принять его в Word, чтобы оно стало постоянным. Передайте tracked=False, чтобы записать текст напрямую, без разметки правок. Аргументы: para_id: Идентификатор (paraId) целевого абзаца. text: Вставляемый текст. position: Куда вставить — "start", "end" или подстрока, после которой вставить. author: Имя автора, отображаемое в панели рецензирования Word (только при tracked=True). context_before: Текст непосредственно перед точкой вставки (для точной привязки). context_after: Текст непосредственно после точки вставки (для точной привязки). ignore_case: Если True, сопоставлять context_before/context_after без учета регистра. tracked: True (по умолчанию) — разметка правок, которую ответственный принимает или отклоняет в Word. False — текст записывается напрямую, без разметки. document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Вставляет текст в абзац. По умолчанию (tracked=True) вставка отмечается как предлагаемое дополнение — оно отображается подчеркнутым в режиме отслеживания изменений Word. Ответственный за проверку должен принять его в Word, чтобы оно стало постоянным. Передайте tracked=False, чтобы записать текст напрямую, без разметки правок. Аргументы: para_id: Идентификатор (paraId) целевого абзаца. text: Вставляемый текст. position: Куда вставить — "start", "end" или подстрока, после которой вставить. author: Имя автора, отображаемое в панели рецензирования Word (только при tracked=True). context_before: Текст непосредственно перед точкой вставки (для точной привязки). context_after: Текст непосредственно после точки вставки (для точной привязки). ignore_case: Если True, сопоставлять context_before/context_after без учета регистра. tracked: True (по умолчанию) — разметка правок, которую ответственный принимает или отклоняет в Word. False — текст записывается напрямую, без разметки. document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • positionstring
  • authorstring
  • context_beforestring
  • context_afterstring
  • ignore_caseboolean
  • trackedboolean
  • document_handlestring
insert_text_box

Вставляет встроенное текстовое поле после абзаца с para_id. Аргументы: para_id: paraId ссылочного абзаца (вставить после него). text: Текстовое содержимое для текстового поля. width_cm: Ширина в сантиметрах (по умолчанию 5.0). height_cm: Высота в сантиметрах (по умолчанию 2.0). Возвращает: JSON с para_id (новый абзац), text, width_cm, height_cm.

Вставляет встроенное текстовое поле после абзаца с para_id. Аргументы: para_id: paraId ссылочного абзаца (вставить после него). text: Текстовое содержимое для текстового поля. width_cm: Ширина в сантиметрах (по умолчанию 5.0). height_cm: Высота в сантиметрах (по умолчанию 2.0). Возвращает: JSON с para_id (новый абзац), text, width_cm, height_cm.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • width_cmnumber
  • height_cmnumber
insert_watermark

Вставляет VML водяной знак в стандартный колонтитул документа. Размещает <v:shape> с <v:textpath> внутри стандартного колонтитула — это стандартный шаблон водяного знака Word. Параметры: - text: Текст водяного знака (например, "ЧЕРНОВИК", "КОНФИДЕНЦИАЛЬНО"). - diagonal: Если True (по умолчанию), диагональная ориентация; если False, горизонтальная. - document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Вставляет VML водяной знак в стандартный колонтитул документа. Размещает <v:shape> с <v:textpath> внутри стандартного колонтитула — это стандартный шаблон водяного знака Word. Параметры: - text: Текст водяного знака (например, "ЧЕРНОВИК", "КОНФИДЕНЦИАЛЬНО"). - diagonal: Если True (по умолчанию), диагональная ориентация; если False, горизонтальная. - document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Параметры

  • textstringобязательный
  • diagonalboolean
  • document_handlestring
list_bookmarks

Перечисли все закладки в документе.

Перечисли все закладки в документе.

Параметры

Без параметров.

list_comment_threads

Вывести все цепочки комментариев (корневые комментарии с ответами к ним). Возвращает список словарей цепочек: {root: {id, author, date, text}, replies: [...]}.

Вывести все цепочки комментариев (корневые комментарии с ответами к ним). Возвращает список словарей цепочек: {root: {id, author, date, text}, replies: [...]}.

Параметры

Без параметров.

list_fields

Выведи все поля в документе с их кодами и кэшированными значениями.

Выведи все поля в документе с их кодами и кэшированными значениями.

Параметры

Без параметров.

list_hyperlinks

Выводит список всех гиперссылок в документе. Возвращает список словарей с ключами: id, url_or_anchor, text, para_id, type. type может быть "external" (на основе r:id) или "internal" (на основе w:anchor).

Выводит список всех гиперссылок в документе. Возвращает список словарей с ключами: id, url_or_anchor, text, para_id, type. type может быть "external" (на основе r:id) или "internal" (на основе w:anchor).

Параметры

Без параметров.

list_parts

Выведи список всех XML-частей (файлов) в открытом ZIP-архиве DOCX.

Выведи список всех XML-частей (файлов) в открытом ZIP-архиве DOCX.

Параметры

Без параметров.

list_template_fields

Перечисли все поля шаблона SDT (тег, метка, тип) в документе.

Перечисли все поля шаблона SDT (тег, метка, тип) в документе.

Параметры

Без параметров.

lock_content_control

Заблокировать элемент управления содержимым, чтобы запретить редактирование. Аргументы: tag: Имя тега блокируемого элемента управления. lock: Тип блокировки - sdtLocked|contentLocked|sdtContentLocked.

Заблокировать элемент управления содержимым, чтобы запретить редактирование. Аргументы: tag: Имя тега блокируемого элемента управления. lock: Тип блокировки - sdtLocked|contentLocked|sdtContentLocked.

Параметры

  • tagstringобязательный
  • lockstring
merge_cells

Объединяет прямоугольный диапазон ячеек. По горизонтали: gridSpan. По вертикали: vMerge.

Объединяет прямоугольный диапазон ячеек. По горизонтали: gridSpan. По вертикали: vMerge.

Параметры

  • table_indexintegerобязательный
  • start_rowintegerобязательный
  • start_colintegerобязательный
  • end_rowintegerобязательный
  • end_colintegerобязательный
merge_documents

Объединить содержимое другого DOCX-документа с текущим документом.

Объединить содержимое другого DOCX-документа с текущим документом.

Параметры

  • source_pathstringобязательный
  • document_handlestring
merge_review_rounds

Объединить отслеживаемые изменения из N копий рецензентов в открытый документ.

Объединить отслеживаемые изменения из N копий рецензентов в открытый документ.

Параметры

  • reviewer_pathsstring[]обязательный
  • base_pathany
modify_cell

Изменить ячейку таблицы. По умолчанию (tracked=True) старое содержимое помечается как удалённое, а новое — как вставка: человек-рецензент принимает или отклоняет изменения в режиме отслеживания правок Word. Передайте tracked=False, чтобы перезаписать ячейку напрямую, без разметки. Args: table_idx: Индекс таблицы (начиная с 0). row: Индекс строки (начиная с 0). col: Индекс столбца (начиная с 0). text: Новый текст ячейки. author: Имя автора, отображаемое в панели рецензирования Word (только при tracked=True). tracked: True (по умолчанию): отслеживаемое удаление и вставка. False: прямая перезапись без разметки. document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Изменить ячейку таблицы. По умолчанию (tracked=True) старое содержимое помечается как удалённое, а новое — как вставка: человек-рецензент принимает или отклоняет изменения в режиме отслеживания правок Word. Передайте tracked=False, чтобы перезаписать ячейку напрямую, без разметки. Args: table_idx: Индекс таблицы (начиная с 0). row: Индекс строки (начиная с 0). col: Индекс столбца (начиная с 0). text: Новый текст ячейки. author: Имя автора, отображаемое в панели рецензирования Word (только при tracked=True). tracked: True (по умолчанию): отслеживаемое удаление и вставка. False: прямая перезапись без разметки. document_handle: Необязательный дескриптор для изоляции параллельных сеансов.

Параметры

  • table_idxintegerобязательный
  • rowintegerобязательный
  • colintegerобязательный
  • textstringобязательный
  • authorstring
  • trackedboolean
  • document_handlestring
open_document

Открывает файл .docx для чтения и редактирования. Распаковывает архив DOCX, разбирает все XML-части и кэширует их в памяти под дескриптором. Несколько документов могут быть открыты одновременно, каждый под своим дескриптором. Аргументы: path: Абсолютный путь к файлу .docx. document_handle: Необязательный дескриптор для сохранения этого документа. Пустая строка использует общий слот `__default__` (устаревшее поведение); передавайте уникальное значение (например, UUID) для каждого параллельного сеанса для изоляции.

Открывает файл .docx для чтения и редактирования. Распаковывает архив DOCX, разбирает все XML-части и кэширует их в памяти под дескриптором. Несколько документов могут быть открыты одновременно, каждый под своим дескриптором. Аргументы: path: Абсолютный путь к файлу .docx. document_handle: Необязательный дескриптор для сохранения этого документа. Пустая строка использует общий слот `__default__` (устаревшее поведение); передавайте уникальное значение (например, UUID) для каждого параллельного сеанса для изоляции.

Параметры

  • pathstringобязательный
  • document_handlestring
promote_list_item

Уменьшите уровень отступа списка (ilvl) для абзаца на 1, минимальное значение — 0. Возвращает {para_id, ilvl}. Вызывает ValueError, если абзац не является элементом списка.

Уменьшите уровень отступа списка (ilvl) для абзаца на 1, минимальное значение — 0. Возвращает {para_id, ilvl}. Вызывает ValueError, если абзац не является элементом списка.

Параметры

  • para_idstringобязательный
read_part

Читает сырой XML любой части DOCX (например, 'word/document.xml'). Используйте list_parts(), чтобы узнать доступные части.

Читает сырой XML любой части DOCX (например, 'word/document.xml'). Используйте list_parts(), чтобы узнать доступные части.

Параметры

  • part_pathstringобязательный
redact_text

Истинное удаление: удаляет текст и заменяет чёрным прямоугольником. Используйте exact_text или pattern. Args: pattern: Regex-шаблон для поиска текста run. para_ids: Необязательный список значений paraId абзацев для ограничения области поиска. exact_text: Точная строка для сопоставления с текстом run. reason: Причина удаления (сохраняется в логе).

Истинное удаление: удаляет текст и заменяет чёрным прямоугольником. Используйте exact_text или pattern. Args: pattern: Regex-шаблон для поиска текста run. para_ids: Необязательный список значений paraId абзацев для ограничения области поиска. exact_text: Точная строка для сопоставления с текстом run. reason: Причина удаления (сохраняется в логе).

Параметры

  • patternany
  • para_idsany
  • exact_textany
  • reasonstring
reject_all_changes

Отклонить все отслеженные изменения в порядке документа. Возвращает JSON-объект с количеством отклоненных изменений: {"rejected": int}.

Отклонить все отслеженные изменения в порядке документа. Возвращает JSON-объект с количеством отклоненных изменений: {"rejected": int}.

Параметры

Без параметров.

reject_change

Отклоняет одно отслеживаемое изменение по его change_id. Для вставок: отбрасывает вставленный текст (удаляет w:ins). Для удалений: сохраняет удалённый текст (разворачивает w:del, восстанавливая текст). Аргументы: change_id: Целочисленный атрибут id элемента w:ins или w:del.

Отклоняет одно отслеживаемое изменение по его change_id. Для вставок: отбрасывает вставленный текст (удаляет w:ins). Для удалений: сохраняет удалённый текст (разворачивает w:del, восстанавливая текст). Аргументы: change_id: Целочисленный атрибут id элемента w:ins или w:del.

Параметры

  • change_idintegerобязательный
reject_changes

Отклонить отслеженные изменения: удалить вставки, восстановить удаленный текст.

Отклонить отслеженные изменения: удалить вставки, восстановить удаленный текст.

Параметры

  • authorstring
  • document_handlestring
remove_bookmark

Удалить закладку по имени (содержимое абзаца сохраняется).

Удалить закладку по имени (содержимое абзаца сохраняется).

Параметры

  • namestringобязательный
remove_hyperlink

Удалить обертку гиперссылки, сохранив текстовые runs внутри. Текст абзаца остается; разворачивается только элемент w:hyperlink. Аргументы: para_id: w14:paraId абзаца, содержащего гиперссылку. url_or_anchor: URL (для внешней) или имя закладки (для внутренней) для сопоставления.

Удалить обертку гиперссылки, сохранив текстовые runs внутри. Текст абзаца остается; разворачивается только элемент w:hyperlink. Аргументы: para_id: w14:paraId абзаца, содержащего гиперссылку. url_or_anchor: URL (для внешней) или имя закладки (для внутренней) для сопоставления.

Параметры

  • para_idstringобязательный
  • url_or_anchorstringобязательный
remove_watermark

Удалить водяные знаки VML (например, DRAFT) из всех заголовков документов.

Удалить водяные знаки VML (например, DRAFT) из всех заголовков документов.

Параметры

  • document_handlestring
replace_text

Заменяет текст в абзаце. С `tracked=True` (по умолчанию) старый текст отображается красным зачёркиванием, а новый — подчёркнутой вставкой; проверяющий принимает или отклоняет изменения в Word. Помечается только изменённая часть; совпадающие начало и конец остаются обычным текстом. С `tracked=False` замена применяется сразу без видимой разметки. Аргументы: - `para_id`: идентификатор целевого абзаца. - `find`: текст для поиска и замены (может пересекать границы прогонов). - `replace`: текст замены. - `author`: имя автора, отображаемое в панели проверки Word (только при `tracked=True`). - `context_before`: текст непосредственно перед целевым фрагментом (для точной привязки). - `context_after`: текст непосредственно после целевого фрагмента (для точной привязки). - `tracked`: `True` (по умолчанию) — зачёркивание + подчёркивание, человек принимает/отклоняет. `False` — замена сразу, без разметки. - `document_handle`: необязательный дескриптор для изоляции сеанса.

Заменяет текст в абзаце. С `tracked=True` (по умолчанию) старый текст отображается красным зачёркиванием, а новый — подчёркнутой вставкой; проверяющий принимает или отклоняет изменения в Word. Помечается только изменённая часть; совпадающие начало и конец остаются обычным текстом. С `tracked=False` замена применяется сразу без видимой разметки. Аргументы: - `para_id`: идентификатор целевого абзаца. - `find`: текст для поиска и замены (может пересекать границы прогонов). - `replace`: текст замены. - `author`: имя автора, отображаемое в панели проверки Word (только при `tracked=True`). - `context_before`: текст непосредственно перед целевым фрагментом (для точной привязки). - `context_after`: текст непосредственно после целевого фрагмента (для точной привязки). - `tracked`: `True` (по умолчанию) — зачёркивание + подчёркивание, человек принимает/отклоняет. `False` — замена сразу, без разметки. - `document_handle`: необязательный дескриптор для изоляции сеанса.

Параметры

  • para_idstringобязательный
  • findstringобязательный
  • replacestringобязательный
  • authorstring
  • context_beforestring
  • context_afterstring
  • ignore_caseboolean
  • trackedboolean
  • document_handlestring
reply_to_comment

Ответить на существующий комментарий (создаёт вложенный ответ).

Ответить на существующий комментарий (создаёт вложенный ответ).

Параметры

  • parent_idintegerобязательный
  • textstringобязательный
  • authorstring
  • document_handlestring
resolve_comment

Помечает комментарий как решённый (устанавливает w15:done='1' в commentsExtended.xml). Аргументы: comment_id: ID комментария, который нужно пометить как решённый.

Помечает комментарий как решённый (устанавливает w15:done='1' в commentsExtended.xml). Аргументы: comment_id: ID комментария, который нужно пометить как решённый.

Параметры

  • comment_idintegerобязательный
restart_numbering

Перезапускает нумерацию списка с указанного абзаца. Добавляет lvlOverride с startOverride.

Перезапускает нумерацию списка с указанного абзаца. Добавляет lvlOverride с startOverride.

Параметры

  • para_idstringобязательный
  • levelinteger
  • startinteger
sanitize_metadata

Записывает очищенную копию открытого документа в output_path. Уровень 1: удаляет из document.xml атрибуты rsid — отпечатки сессии. Уровень 2: + заменяет имена авторов отслеживаемых правок (w:author в w:ins/w:del). Уровень 3: + очищает creator/lastModifiedBy/revision в docProps/core.xml + очищает Company в docProps/app.xml + удаляет ссылку attachedTemplate из word/settings.xml Аргументы: output_path: путь к очищенному DOCX. Обязателен, не может быть пустым. level: глубина очистки (1, 2 или 3). По умолчанию 1. redact_authors_as: строка для замены авторов на уровне 2+. По умолчанию "Anonymous".

Записывает очищенную копию открытого документа в output_path. Уровень 1: удаляет из document.xml атрибуты rsid — отпечатки сессии. Уровень 2: + заменяет имена авторов отслеживаемых правок (w:author в w:ins/w:del). Уровень 3: + очищает creator/lastModifiedBy/revision в docProps/core.xml + очищает Company в docProps/app.xml + удаляет ссылку attachedTemplate из word/settings.xml Аргументы: output_path: путь к очищенному DOCX. Обязателен, не может быть пустым. level: глубина очистки (1, 2 или 3). По умолчанию 1. redact_authors_as: строка для замены авторов на уровне 2+. По умолчанию "Anonymous".

Параметры

  • output_pathstringобязательный
  • levelinteger
  • redact_authors_asstring
save_document

Сохраняет все изменения обратно в файл .docx. Аргументы: output_path: Путь к выходному файлу. Если пусто — перезаписывает исходный путь документа, связанного с этим дескриптором. document_handle: Дескриптор документа для сохранения. Пусто = `__default__`.

Сохраняет все изменения обратно в файл .docx. Аргументы: output_path: Путь к выходному файлу. Если пусто — перезаписывает исходный путь документа, связанного с этим дескриптором. document_handle: Дескриптор документа для сохранения. Пусто = `__default__`.

Параметры

  • output_pathstring
  • document_handlestring
scrub_pii

[ЭКСПЕРИМЕНТАЛЬНО] Обнаружение и удаление PII из открытого документа с помощью Presidio + spaCy NER. ПРЕДУПРЕЖДЕНИЕ: Этот инструмент ПРОПУСТИТ PII. Он экспериментальный и НЕ подходит для продакшена и не может быть единственным средством контроля для документов с привилегиями, регуляцией или юридической чувствительностью. Всегда сначала запускайте с dry_run=True и вручную проверяйте каждую обнаруженную сущность, прежде чем сохранять файл с удалёнными данными. Известные ограничения (пробелы статистического NER): - Имена, написанные ЗАГЛАВНЫМИ (заголовки реестров, ячейки таблиц) часто пропускаются. - Имена из одного токена без контекста вокруг — ненадёжны. - Неанглийские имена (арабские, китайские/японские/корейские, африканские) имеют низкий охват на этой английской модели. - Имена, встроенные в юридические шаблоны ("Borrower: Jane Doe"), часто пропускаются. NER-модель (en_core_web_lg, ~560 МБ) скачивается автоматически при первом использовании. Обнаруживает: PERSON, EMAIL_ADDRESS, PHONE_NUMBER, CREDIT_CARD, SSN, IP_ADDRESS, IBAN_CODE, US_BANK_NUMBER, US_PASSPORT и другие через Presidio. Текст заменяется сплошным чёрным прямоугольником DrawingML — настоящее XML-редактирование, при котором исходный текст полностью удаляется из OOXML, а не просто скрывается форматированием. Аргументы: output_path: Путь для сохранения. Обязателен, когда dry_run=False. entities: Типы сущностей Presidio для удаления. None — все обнаруженные типы. confidence_threshold: Минимальный порог уверенности Presidio (по умолчанию 0.35). dry_run: Если True, только обнаружение — вернуть список сущностей, файл не записывать. also_sanitize_metadata: Применить очистку метаданных уровня 3 (по умолчанию True). redact_authors_as: Строка замены для автора при обработке метаданных.

[ЭКСПЕРИМЕНТАЛЬНО] Обнаружение и удаление PII из открытого документа с помощью Presidio + spaCy NER. ПРЕДУПРЕЖДЕНИЕ: Этот инструмент ПРОПУСТИТ PII. Он экспериментальный и НЕ подходит для продакшена и не может быть единственным средством контроля для документов с привилегиями, регуляцией или юридической чувствительностью. Всегда сначала запускайте с dry_run=True и вручную проверяйте каждую обнаруженную сущность, прежде чем сохранять файл с удалёнными данными. Известные ограничения (пробелы статистического NER): - Имена, написанные ЗАГЛАВНЫМИ (заголовки реестров, ячейки таблиц) часто пропускаются. - Имена из одного токена без контекста вокруг — ненадёжны. - Неанглийские имена (арабские, китайские/японские/корейские, африканские) имеют низкий охват на этой английской модели. - Имена, встроенные в юридические шаблоны ("Borrower: Jane Doe"), часто пропускаются. NER-модель (en_core_web_lg, ~560 МБ) скачивается автоматически при первом использовании. Обнаруживает: PERSON, EMAIL_ADDRESS, PHONE_NUMBER, CREDIT_CARD, SSN, IP_ADDRESS, IBAN_CODE, US_BANK_NUMBER, US_PASSPORT и другие через Presidio. Текст заменяется сплошным чёрным прямоугольником DrawingML — настоящее XML-редактирование, при котором исходный текст полностью удаляется из OOXML, а не просто скрывается форматированием. Аргументы: output_path: Путь для сохранения. Обязателен, когда dry_run=False. entities: Типы сущностей Presidio для удаления. None — все обнаруженные типы. confidence_threshold: Минимальный порог уверенности Presidio (по умолчанию 0.35). dry_run: Если True, только обнаружение — вернуть список сущностей, файл не записывать. also_sanitize_metadata: Применить очистку метаданных уровня 3 (по умолчанию True). redact_authors_as: Строка замены для автора при обработке метаданных.

Параметры

  • output_pathstring
  • entitiesany
  • confidence_thresholdnumber
  • dry_runboolean
  • also_sanitize_metadataboolean
  • redact_authors_asstring
search_text

Ищет текст по всему документу: основному тексту, сноскам и комментариям. Аргументы: query: Текст для поиска (без учёта регистра) или regex-шаблон. regex: Если true, query обрабатывается как регулярное выражение Python. Возвращает подходящие абзацы с их paraId, частью источника и контекстом.

Ищет текст по всему документу: основному тексту, сноскам и комментариям. Аргументы: query: Текст для поиска (без учёта регистра) или regex-шаблон. regex: Если true, query обрабатывается как регулярное выражение Python. Возвращает подходящие абзацы с их paraId, частью источника и контекстом.

Параметры

  • querystringобязательный
  • regexboolean
  • document_handlestring
set_alt_text

Устанавливает замещающий текст (и опционально заголовок) для изображения по индексу, начиная с 0. Аргументы: image_index: индекс (начиная с 0) среди всех элементов wp:docPr в document.xml. alt_text: описание для доступности, которое нужно установить для изображения. title: опциональный атрибут заголовка; удаляется из XML, если пустой. Возвращает: {"image_index": int, "alt_text": str}

Устанавливает замещающий текст (и опционально заголовок) для изображения по индексу, начиная с 0. Аргументы: image_index: индекс (начиная с 0) среди всех элементов wp:docPr в document.xml. alt_text: описание для доступности, которое нужно установить для изображения. title: опциональный атрибут заголовка; удаляется из XML, если пустой. Возвращает: {"image_index": int, "alt_text": str}

Параметры

  • image_indexintegerобязательный
  • alt_textstringобязательный
  • titlestring
set_cell_shading

Установить цвет заливки фона в ячейке таблицы.

Установить цвет заливки фона в ячейке таблицы.

Параметры

  • table_idxintegerобязательный
  • row_idxintegerобязательный
  • col_idxintegerобязательный
  • fill_colorstringобязательный
  • patternstring
set_cell_vertical_alignment

Установить вертикальное выравнивание ячейки таблицы: сверху, по центру или снизу.

Установить вертикальное выравнивание ячейки таблицы: сверху, по центру или снизу.

Параметры

  • table_idxintegerобязательный
  • row_idxintegerобязательный
  • col_idxintegerобязательный
  • alignmentstringобязательный
set_cell_width

Установить ширину ячейки таблицы в миллиметрах (хранится в DXA).

Установить ширину ячейки таблицы в миллиметрах (хранится в DXA).

Параметры

  • table_idxintegerобязательный
  • row_idxintegerобязательный
  • col_idxintegerобязательный
  • width_mmnumberобязательный
set_character_position

Устанавливает вертикальное положение символов (приподнято/опущено) для заданного фрагмента. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс фрагмента (начиная с нуля). position_pt: Смещение в пунктах (положительное — приподнято, отрицательное — опущено).

Устанавливает вертикальное положение символов (приподнято/опущено) для заданного фрагмента. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс фрагмента (начиная с нуля). position_pt: Смещение в пунктах (положительное — приподнято, отрицательное — опущено).

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • position_ptnumberобязательный
set_character_spacing

Устанавливает межсимвольный интервал (трекинг) для указанного пробега в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс пробега, начиная с нуля. spacing_pt: Интервал в пунктах (положительное значение — расширенный, отрицательное — сжатый).

Устанавливает межсимвольный интервал (трекинг) для указанного пробега в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс пробега, начиная с нуля. spacing_pt: Интервал в пунктах (положительное значение — расширенный, отрицательное — сжатый).

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • spacing_ptnumberобязательный
set_column_widths

Установите ширину столбцов в см. len(widths_cm) должна соответствовать количеству столбцов.

Установите ширину столбцов в см. len(widths_cm) должна соответствовать количеству столбцов.

Параметры

  • table_indexintegerобязательный
  • widths_cmnumber[]обязательный
set_content_control_value

Обновляет значение/текст элемента управления содержимым по его тегу. Аргументы: tag: Имя тега обновляемого элемента управления. value: Новое значение. Для флажка: 'true'/'1' = отмечен, 'false'/'0' = не отмечен.

Обновляет значение/текст элемента управления содержимым по его тегу. Аргументы: tag: Имя тега обновляемого элемента управления. value: Новое значение. Для флажка: 'true'/'1' = отмечен, 'false'/'0' = не отмечен.

Параметры

  • tagstringобязательный
  • valuestringобязательный
set_custom_property

Устанавливает (upsert) пользовательское свойство документа. Аргументы: name: Имя свойства. value: Значение свойства в виде строки. vt_type: Имя элемента типа VT (lpwstr, i4, bool и т.д.).

Устанавливает (upsert) пользовательское свойство документа. Аргументы: name: Имя свойства. value: Значение свойства в виде строки. vt_type: Имя элемента типа VT (lpwstr, i4, bool и т.д.).

Параметры

  • namestringобязательный
  • valuestringобязательный
  • vt_typestring
set_different_first_page

Включить или отключить отдельный верхний/нижний колонтитул на первой странице раздела. При включении раздел может иметь уникальный колонтитул на первой странице, отдельный от колонтитулов на последующих страницах. Args: section_index: Индекс раздела, начиная с нуля (используйте get_sections, чтобы его найти). enabled: True - включить отдельную первую страницу, False - отключить. Returns: {"section_index": int, "different_first_page": bool}

Включить или отключить отдельный верхний/нижний колонтитул на первой странице раздела. При включении раздел может иметь уникальный колонтитул на первой странице, отдельный от колонтитулов на последующих страницах. Args: section_index: Индекс раздела, начиная с нуля (используйте get_sections, чтобы его найти). enabled: True - включить отдельную первую страницу, False - отключить. Returns: {"section_index": int, "different_first_page": bool}

Параметры

  • section_indexintegerобязательный
  • enabledbooleanобязательный
set_document_language

Устанавливает язык документа по умолчанию. Записывает тег языка BCP-47 в свойства run стиля абзаца по умолчанию (``w:rPr/w:lang``) в ``word/styles.xml``. Args: language_code: тег языка BCP-47, например "en-US", "fr-FR", "de-DE". Returns: {"language": language_code}

Устанавливает язык документа по умолчанию. Записывает тег языка BCP-47 в свойства run стиля абзаца по умолчанию (``w:rPr/w:lang``) в ``word/styles.xml``. Args: language_code: тег языка BCP-47, например "en-US", "fr-FR", "de-DE". Returns: {"language": language_code}

Параметры

  • language_codestringобязательный
set_document_protection

Установить защиту документа. edit: trackedChanges/comments/readOnly/forms/none.

Установить защиту документа. edit: trackedChanges/comments/readOnly/forms/none.

Параметры

  • editstringобязательный
  • passwordstring
  • document_handlestring
set_formatting

Применить форматирование символов к тексту с разметкой отслеживаемых изменений.

Применить форматирование символов к тексту с разметкой отслеживаемых изменений.

Параметры

  • para_idstringобязательный
  • textstringобязательный
  • boldboolean
  • italicboolean
  • underlinestring
  • colorstring
  • authorstring
  • document_handlestring
set_header_row

Отметьте первую строку как повторяющуюся строку заголовка.

Отметьте первую строку как повторяющуюся строку заголовка.

Параметры

  • table_indexintegerобязательный
set_image_alt_text

Задаёт альтернативный текст и заголовок для встроенного изображения. Аргументы: rId: идентификатор связи изображения. alt_text: альтернативный текст (атрибут descr в wp:docPr). title: необязательный атрибут заголовка в wp:docPr.

Задаёт альтернативный текст и заголовок для встроенного изображения. Аргументы: rId: идентификатор связи изображения. alt_text: альтернативный текст (атрибут descr в wp:docPr). title: необязательный атрибут заголовка в wp:docPr.

Параметры

  • rIdstringобязательный
  • alt_textstringобязательный
  • titlestring
set_image_border

Устанавливает или убирает границу у встроенного изображения. Аргументы: rId: идентификатор отношения изображения (например, 'rId6'). border_pt: ширина границы в пунктах. Укажите 0, чтобы убрать границу. color: строка RGB-цвета в шестнадцатеричном формате без символа '#' (по умолчанию '000000' – чёрный). Возвращает: JSON с полями rId, border_pt и color.

Устанавливает или убирает границу у встроенного изображения. Аргументы: rId: идентификатор отношения изображения (например, 'rId6'). border_pt: ширина границы в пунктах. Укажите 0, чтобы убрать границу. color: строка RGB-цвета в шестнадцатеричном формате без символа '#' (по умолчанию '000000' – чёрный). Возвращает: JSON с полями rId, border_pt и color.

Параметры

  • rIdstringобязательный
  • border_ptnumberобязательный
  • colorstring
set_image_size

Изменяет размер встроенного изображения, обновляя его атрибуты EMU extent. Аргументы: rId: Идентификатор отношения (relationship ID) изображения, размер которого нужно изменить. width_cm: Новая ширина в сантиметрах. height_cm: Новая высота в сантиметрах.

Изменяет размер встроенного изображения, обновляя его атрибуты EMU extent. Аргументы: rId: Идентификатор отношения (relationship ID) изображения, размер которого нужно изменить. width_cm: Новая ширина в сантиметрах. height_cm: Новая высота в сантиметрах.

Параметры

  • rIdstringобязательный
  • width_cmnumberобязательный
  • height_cmnumberобязательный
set_keep_lines_together

Оставить все строки этого абзаца на одной странице. Аргументы: para_id: paraId целевого абзаца. enabled: True, чтобы включить keep-lines-together, False, чтобы отключить.

Оставить все строки этого абзаца на одной странице. Аргументы: para_id: paraId целевого абзаца. enabled: True, чтобы включить keep-lines-together, False, чтобы отключить.

Параметры

  • para_idstringобязательный
  • enabledbooleanобязательный
set_keep_with_next

Оставить этот абзац на той же странице, что и следующий абзац. Аргументы: para_id: paraId целевого абзаца. enabled: True для включения keep-with-next, False для отключения.

Оставить этот абзац на той же странице, что и следующий абзац. Аргументы: para_id: paraId целевого абзаца. enabled: True для включения keep-with-next, False для отключения.

Параметры

  • para_idstringобязательный
  • enabledbooleanобязательный
set_line_spacing

Устанавливает межстрочный интервал и интервал между абзацами. Аргументы: para_id: идентификатор абзаца (paraId) целевого абзаца. line_rule: "auto" | "exact" | "atLeast". None — без изменений. line_value: Для "auto": 240 = одинарный, 360 = полуторный, 480 = двойной. Для "exact"/"atLeast": в твипах. space_before_pt: Интервал перед абзацем в пунктах (None = без изменений). space_after_pt: Интервал после абзаца в пунктах (None = без изменений).

Устанавливает межстрочный интервал и интервал между абзацами. Аргументы: para_id: идентификатор абзаца (paraId) целевого абзаца. line_rule: "auto" | "exact" | "atLeast". None — без изменений. line_value: Для "auto": 240 = одинарный, 360 = полуторный, 480 = двойной. Для "exact"/"atLeast": в твипах. space_before_pt: Интервал перед абзацем в пунктах (None = без изменений). space_after_pt: Интервал после абзаца в пунктах (None = без изменений).

Параметры

  • para_idstringобязательный
  • line_ruleany
  • line_valueany
  • space_before_ptany
  • space_after_ptany
set_odd_even_headers

Включить или отключить разные колонтитулы на четных/нечетных страницах глобально. Это настройка уровня документа, хранящаяся в word/settings.xml. Если включено, четные страницы могут использовать другие колонтитулы, отличные от нечетных. Args: enabled: True, чтобы включить разные колонтитулы для четных/нечетных, False, чтобы отключить. Returns: {"odd_even_headers": bool}

Включить или отключить разные колонтитулы на четных/нечетных страницах глобально. Это настройка уровня документа, хранящаяся в word/settings.xml. Если включено, четные страницы могут использовать другие колонтитулы, отличные от нечетных. Args: enabled: True, чтобы включить разные колонтитулы для четных/нечетных, False, чтобы отключить. Returns: {"odd_even_headers": bool}

Параметры

  • enabledbooleanобязательный
set_page_break_before

Принудительно вставить разрыв страницы перед этим абзацем. Аргументы: para_id: paraId целевого абзаца. enabled: True — принудительно вставить разрыв перед, False — убрать его.

Принудительно вставить разрыв страницы перед этим абзацем. Аргументы: para_id: paraId целевого абзаца. enabled: True — принудительно вставить разрыв перед, False — убрать его.

Параметры

  • para_idstringобязательный
  • enabledbooleanобязательный
set_page_margins

Устанавливает поля страницы, заданные в миллиметрах. Аргументы: top_mm: Верхнее поле в мм. None = без изменений. bottom_mm: Нижнее поле в мм. None = без изменений. left_mm: Левое поле в мм. None = без изменений. right_mm: Правое поле в мм. None = без изменений. para_id: paraId абзаца с разрывом раздела. None = основной раздел.

Устанавливает поля страницы, заданные в миллиметрах. Аргументы: top_mm: Верхнее поле в мм. None = без изменений. bottom_mm: Нижнее поле в мм. None = без изменений. left_mm: Левое поле в мм. None = без изменений. right_mm: Правое поле в мм. None = без изменений. para_id: paraId абзаца с разрывом раздела. None = основной раздел.

Параметры

  • top_mmany
  • bottom_mmany
  • left_mmany
  • right_mmany
  • para_idany
set_page_orientation

Устанавливает ориентацию страницы, при необходимости меняя ширину и высоту местами. Аргументы: orientation: "portrait" или "landscape". para_id: paraId абзаца с разрывом раздела. None = основной раздел.

Устанавливает ориентацию страницы, при необходимости меняя ширину и высоту местами. Аргументы: orientation: "portrait" или "landscape". para_id: paraId абзаца с разрывом раздела. None = основной раздел.

Параметры

  • orientationstringобязательный
  • para_idany
set_page_size

Установить размер страницы по значениям в миллиметрах. Параметры: width_mm: Ширина страницы в мм (например, 210 для A4, 215.9 для Letter). height_mm: Высота страницы в мм (например, 297 для A4, 279.4 для Letter). para_id: Идентификатор параграфа с разрывом раздела. None = раздел тела документа.

Установить размер страницы по значениям в миллиметрах. Параметры: width_mm: Ширина страницы в мм (например, 210 для A4, 215.9 для Letter). height_mm: Высота страницы в мм (например, 297 для A4, 279.4 для Letter). para_id: Идентификатор параграфа с разрывом раздела. None = раздел тела документа.

Параметры

  • width_mmnumberобязательный
  • height_mmnumberобязательный
  • para_idany
set_paragraph_border

Устанавливает границы на одной или нескольких сторонах абзаца. Аргументы: para_id: идентификатор целевого абзаца. sides: список сторон: "top", "bottom", "left", "right", "between". color: цвет границы в 6-значном hex (по умолчанию "000000"). size: ширина границы в восьмых долях пункта (по умолчанию 4 = 0,5pt).

Устанавливает границы на одной или нескольких сторонах абзаца. Аргументы: para_id: идентификатор целевого абзаца. sides: список сторон: "top", "bottom", "left", "right", "between". color: цвет границы в 6-значном hex (по умолчанию "000000"). size: ширина границы в восьмых долях пункта (по умолчанию 4 = 0,5pt).

Параметры

  • para_idstringобязательный
  • sidesstring[]обязательный
  • colorstring
  • sizeinteger
set_paragraph_indentation

Устанавливает отступы для абзаца. Аргументы: para_id: идентификатор paraId целевого абзаца. left_cm: левый отступ в сантиметрах (None = без изменений). right_cm: правый отступ в сантиметрах (None = без изменений). first_line_cm: отступ первой строки в см (взаимоисключающий с hanging_cm). hanging_cm: висячий отступ в см (взаимоисключающий с first_line_cm).

Устанавливает отступы для абзаца. Аргументы: para_id: идентификатор paraId целевого абзаца. left_cm: левый отступ в сантиметрах (None = без изменений). right_cm: правый отступ в сантиметрах (None = без изменений). first_line_cm: отступ первой строки в см (взаимоисключающий с hanging_cm). hanging_cm: висячий отступ в см (взаимоисключающий с first_line_cm).

Параметры

  • para_idstringобязательный
  • left_cmany
  • right_cmany
  • first_line_cmany
  • hanging_cmany
set_paragraph_shading

Устанавливает фоновую заливку для абзаца. Аргументы: para_id: идентификатор целевого абзаца. fill_color: цвет заливки в виде шестизначного hex (например, "FFFF00"). pattern: шаблон заливки (по умолчанию "clear").

Устанавливает фоновую заливку для абзаца. Аргументы: para_id: идентификатор целевого абзаца. fill_color: цвет заливки в виде шестизначного hex (например, "FFFF00"). pattern: шаблон заливки (по умолчанию "clear").

Параметры

  • para_idstringобязательный
  • fill_colorstringобязательный
  • patternstring
set_properties

Установить основные свойства документа. Пустая строка = без изменений.

Установить основные свойства документа. Пустая строка = без изменений.

Параметры

  • titlestring
  • creatorstring
  • subjectstring
  • descriptionstring
  • document_handlestring
set_row_height

Устанавливает высоту строки в миллиметрах. Правило: exact, atLeast или auto.

Устанавливает высоту строки в миллиметрах. Правило: exact, atLeast или auto.

Параметры

  • table_idxintegerобязательный
  • row_idxintegerобязательный
  • height_mmnumberобязательный
  • rulestring
set_run_color

Устанавливает цвет шрифта для конкретного run в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс run, начиная с нуля. color: Шестнадцатеричный цвет без # (например, "FF0000").

Устанавливает цвет шрифта для конкретного run в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс run, начиная с нуля. color: Шестнадцатеричный цвет без # (например, "FF0000").

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • colorstringобязательный
set_run_font

Устанавливает шрифт для конкретного фрагмента (с нулевой индексацией) в абзаце. Аргументы: para_id: Идентификатор целевого абзаца. run_idx: Индекс фрагмента (начиная с нуля). font_name: Название шрифта (например, "Arial", "Times New Roman").

Устанавливает шрифт для конкретного фрагмента (с нулевой индексацией) в абзаце. Аргументы: para_id: Идентификатор целевого абзаца. run_idx: Индекс фрагмента (начиная с нуля). font_name: Название шрифта (например, "Arial", "Times New Roman").

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • font_namestringобязательный
set_run_highlight

Устанавливает цвет выделения для конкретного фрагмента в абзаце. Аргументы: para_id: идентификатор целевого абзаца. run_idx: индекс фрагмента, начиная с нуля. color: название цвета выделения слова (например, "yellow", "green", "cyan", "none").

Устанавливает цвет выделения для конкретного фрагмента в абзаце. Аргументы: para_id: идентификатор целевого абзаца. run_idx: индекс фрагмента, начиная с нуля. color: название цвета выделения слова (например, "yellow", "green", "cyan", "none").

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • colorstringобязательный
set_run_language

Устанавливает язык прогона для проверки орфографии. Аргументы: para_id: идентификатор целевого абзаца. run_idx: индекс прогона (начиная с нуля). language_code: код языка BCP-47 (например, "en-US", "fr-FR", "de-DE").

Устанавливает язык прогона для проверки орфографии. Аргументы: para_id: идентификатор целевого абзаца. run_idx: индекс прогона (начиная с нуля). language_code: код языка BCP-47 (например, "en-US", "fr-FR", "de-DE").

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • language_codestringобязательный
set_run_size

Устанавливает размер шрифта для определённого фрагмента (run) в абзаце. Аргументы: para_id: идентификатор (paraId) целевого абзаца. run_idx: индекс фрагмента (run), отсчёт от нуля. size_pt: размер шрифта в пунктах (например, 12.0).

Устанавливает размер шрифта для определённого фрагмента (run) в абзаце. Аргументы: para_id: идентификатор (paraId) целевого абзаца. run_idx: индекс фрагмента (run), отсчёт от нуля. size_pt: размер шрифта в пунктах (например, 12.0).

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • size_ptnumberобязательный
set_run_strikethrough

Установить зачёркивание для конкретного фрагмента в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс фрагмента, начиная с нуля. double: False для одинарного зачёркивания, True для двойного.

Установить зачёркивание для конкретного фрагмента в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс фрагмента, начиная с нуля. double: False для одинарного зачёркивания, True для двойного.

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • doubleboolean
set_run_subscript

Устанавливает вертикальное выравнивание подстрочного индекса для конкретного прогона в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс прогона, начиная с нуля.

Устанавливает вертикальное выравнивание подстрочного индекса для конкретного прогона в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс прогона, начиная с нуля.

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
set_run_superscript

Установить надстрочное вертикальное выравнивание для конкретного фрагмента в абзаце. Аргументы: para_id: идентификатор абзаца (paraId) целевого абзаца. run_idx: индекс фрагмента, начиная с нуля.

Установить надстрочное вертикальное выравнивание для конкретного фрагмента в абзаце. Аргументы: para_id: идентификатор абзаца (paraId) целевого абзаца. run_idx: индекс фрагмента, начиная с нуля.

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
set_run_underline

Устанавливает стиль подчёркивания для конкретного фрагмента (run) в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс фрагмента, начиная с нуля. style: Стиль подчёркивания (например, "single", "double", "dotted", "none").

Устанавливает стиль подчёркивания для конкретного фрагмента (run) в абзаце. Аргументы: para_id: paraId целевого абзаца. run_idx: Индекс фрагмента, начиная с нуля. style: Стиль подчёркивания (например, "single", "double", "dotted", "none").

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • stylestring
set_section_columns

Устанавливает количество колонок в разделе. Аргументы: section_index: Индекс раздела, начиная с нуля (используйте get_sections, чтобы его найти). num_columns: Количество текстовых колонок (1 = одна колонка). equal_width: Если True, все колонки одинаковой ширины. По умолчанию True.

Устанавливает количество колонок в разделе. Аргументы: section_index: Индекс раздела, начиная с нуля (используйте get_sections, чтобы его найти). num_columns: Количество текстовых колонок (1 = одна колонка). equal_width: Если True, все колонки одинаковой ширины. По умолчанию True.

Параметры

  • section_indexintegerобязательный
  • num_columnsintegerобязательный
  • equal_widthboolean
set_section_properties

Изменить свойства раздела (размер страницы, ориентацию, поля). 0/пусто = без изменений.

Изменить свойства раздела (размер страницы, ориентацию, поля). 0/пусто = без изменений.

Параметры

  • para_idstring
  • widthinteger
  • heightinteger
  • orientationstring
  • margin_topinteger
  • margin_bottominteger
  • margin_leftinteger
  • margin_rightinteger
  • document_handlestring
set_table_alignment

Установите выравнивание таблицы: слева, по центру или справа.

Установите выравнивание таблицы: слева, по центру или справа.

Параметры

  • table_idxintegerобязательный
  • alignmentstringобязательный
set_table_borders

Установить границы на всех шести сторонах таблицы (верх, низ, лево, право, внутри по горизонтали, внутри по вертикали).

Установить границы на всех шести сторонах таблицы (верх, низ, лево, право, внутри по горизонтали, внутри по вертикали).

Параметры

  • table_idxintegerобязательный
  • border_stylestring
  • colorstring
  • sizeinteger
set_table_style

Примените именованный стиль таблицы (например, TableGrid, LightShading-Accent1) к таблице.

Примените именованный стиль таблицы (например, TableGrid, LightShading-Accent1) к таблице.

Параметры

  • table_idxintegerобязательный
  • style_namestringобязательный
set_text_case

Устанавливает преобразование регистра текста для run. Аргументы: para_id: идентификатор абзаца целевого параграфа. run_idx: индекс run (начиная с нуля). case: "upper" (все прописные), "small" (капитель) или "none" (убрать преобразование регистра).

Устанавливает преобразование регистра текста для run. Аргументы: para_id: идентификатор абзаца целевого параграфа. run_idx: индекс run (начиная с нуля). case: "upper" (все прописные), "small" (капитель) или "none" (убрать преобразование регистра).

Параметры

  • para_idstringобязательный
  • run_idxintegerобязательный
  • casestringобязательный
set_theme_color

Обновляет именованный слот цвета в теме документа. Аргументы: slot: Один из: dk1, lt1, dk2, lt2, accent1-accent6, hlink, folHlink. hex_color: 6-символьная шестнадцатеричная строка без # (например, "FF0000").

Обновляет именованный слот цвета в теме документа. Аргументы: slot: Один из: dk1, lt1, dk2, lt2, accent1-accent6, hlink, folHlink. hex_color: 6-символьная шестнадцатеричная строка без # (например, "FF0000").

Параметры

  • slotstringобязательный
  • hex_colorstringобязательный
set_track_changes

Включить или отключить отслеживание ревизий в документе. Когда функция включена, Word/LibreOffice будет записывать будущие правки как отслеженные изменения. Аргументы: enabled: True — включить отслеживание, False — отключить. author: Опциональное имя автора (сохраняется в ответе только для справки). Возвращает: {"track_changes": bool, "author": str}

Включить или отключить отслеживание ревизий в документе. Когда функция включена, Word/LibreOffice будет записывать будущие правки как отслеженные изменения. Аргументы: enabled: True — включить отслеживание, False — отключить. author: Опциональное имя автора (сохраняется в ответе только для справки). Возвращает: {"track_changes": bool, "author": str}

Параметры

  • enabledbooleanобязательный
  • authorstring
set_widow_control

Включить управление висячими строками для этого абзаца. Аргументы: para_id: paraId целевого абзаца. enabled: True — включить управление висячими строками, False — отключить.

Включить управление висячими строками для этого абзаца. Аргументы: para_id: paraId целевого абзаца. enabled: True — включить управление висячими строками, False — отключить.

Параметры

  • para_idstringобязательный
  • enabledbooleanобязательный
sort_table

Сортирует строки таблицы без заголовков по текстовому содержимому столбца. Строки заголовков (отмеченные w:tblHeader) остаются наверху. Строки с отсутствующей ячейкой в column_index сортируются как пустая строка. Аргументы: table_idx: индекс таблицы, начиная с 0. column_index: индекс столбца для сортировки, начиная с 0. ascending: True для A→Z (по умолчанию), False для Z→A. Возвращает: {"sorted_rows": int, "column_index": int, "ascending": bool}

Сортирует строки таблицы без заголовков по текстовому содержимому столбца. Строки заголовков (отмеченные w:tblHeader) остаются наверху. Строки с отсутствующей ячейкой в column_index сортируются как пустая строка. Аргументы: table_idx: индекс таблицы, начиная с 0. column_index: индекс столбца для сортировки, начиная с 0. ascending: True для A→Z (по умолчанию), False для Z→A. Возвращает: {"sorted_rows": int, "column_index": int, "ascending": bool}

Параметры

  • table_idxintegerобязательный
  • column_indexintegerобязательный
  • ascendingboolean
split_document

Разделяет открытый документ на несколько DOCX-файлов, по одному на каждый раздел заголовка. Аргументы: output_dir: Каталог для выходных файлов. По умолчанию <workdir>/split_output. at_heading_level: Уровень заголовка, по которому выполняется разделение (по умолчанию 1). Возвращает: {"output_dir": str, "files": list[str], "parts": int}

Разделяет открытый документ на несколько DOCX-файлов, по одному на каждый раздел заголовка. Аргументы: output_dir: Каталог для выходных файлов. По умолчанию <workdir>/split_output. at_heading_level: Уровень заголовка, по которому выполняется разделение (по умолчанию 1). Возвращает: {"output_dir": str, "files": list[str], "parts": int}

Параметры

  • output_dirstring
  • at_heading_levelinteger
split_table

Разделяет таблицу на две по указанному индексу строки. Строки с 0 по at_row_index-1 остаются в исходной таблице; строки с at_row_index до конца переносятся в новую таблицу, которая вставляется сразу после. Аргументы: table_idx: индекс таблицы, начиная с 0. at_row_index: индекс строки, по которой разделяем (начиная с 0; должен быть > 0 и < row_count). Возвращает: {"table1_rows": int, "table2_rows": int}

Разделяет таблицу на две по указанному индексу строки. Строки с 0 по at_row_index-1 остаются в исходной таблице; строки с at_row_index до конца переносятся в новую таблицу, которая вставляется сразу после. Аргументы: table_idx: индекс таблицы, начиная с 0. at_row_index: индекс строки, по которой разделяем (начиная с 0; должен быть > 0 и < row_count). Возвращает: {"table1_rows": int, "table2_rows": int}

Параметры

  • table_idxintegerобязательный
  • at_row_indexintegerобязательный
suppress_numbering

Удаляет нумерацию списка из абзаца, устанавливая numId в 0.

Удаляет нумерацию списка из абзаца, устанавливая numId в 0.

Параметры

  • para_idstringобязательный
table_to_csv

Экспортировать таблицу как строку CSV.

Экспортировать таблицу как строку CSV.

Параметры

  • table_indexintegerобязательный
update_chart_data

Заменить ряды данных в существующей диаграмме по chart_id. series: [{"name": str, "values": [float, ...]}]

Заменить ряды данных в существующей диаграмме по chart_id. series: [{"name": str, "values": [float, ...]}]

Параметры

  • chart_idstringобязательный
  • seriesobject[]обязательный
update_comment

Заменить текст существующего комментария. Аргументы: comment_id: ID комментария для обновления. text: Новый текст комментария.

Заменить текст существующего комментария. Аргументы: comment_id: ID комментария для обновления. text: Новый текст комментария.

Параметры

  • comment_idintegerобязательный
  • textstringобязательный
update_content_control

Изменяет свойства существующего элемента управления содержимым. Аргументы: control_id: Значение w:id элемента управления, который нужно обновить. title: Новый заголовок (w:alias/@w:val). Опустите, чтобы оставить без изменений. tag: Новый тег (w:tag/@w:val). Опустите, чтобы оставить без изменений. placeholder_text: Новый текст-заполнитель. Опустите, чтобы оставить без изменений.

Изменяет свойства существующего элемента управления содержимым. Аргументы: control_id: Значение w:id элемента управления, который нужно обновить. title: Новый заголовок (w:alias/@w:val). Опустите, чтобы оставить без изменений. tag: Новый тег (w:tag/@w:val). Опустите, чтобы оставить без изменений. placeholder_text: Новый текст-заполнитель. Опустите, чтобы оставить без изменений.

Параметры

  • control_idstringобязательный
  • titleany
  • tagany
  • placeholder_textany
update_endnote

Обновляет текст существующей концевой сноски. Аргументы: endnote_id: Числовой идентификатор концевой сноски для обновления (должен быть >= 1). text: Новый текст концевой сноски.

Обновляет текст существующей концевой сноски. Аргументы: endnote_id: Числовой идентификатор концевой сноски для обновления (должен быть >= 1). text: Новый текст концевой сноски.

Параметры

  • endnote_idintegerобязательный
  • textstringобязательный
update_fields

Пометить все поля как требующие обновления, чтобы Word пересчитал их при открытии.

Пометить все поля как требующие обновления, чтобы Word пересчитал их при открытии.

Параметры

Без параметров.

update_footnote

Обновляет текст существующей сноски. Аргументы: footnote_id: Числовой идентификатор сноски для обновления (должен быть >= 1). text: Новое текстовое содержимое сноски.

Обновляет текст существующей сноски. Аргументы: footnote_id: Числовой идентификатор сноски для обновления (должен быть >= 1). text: Новое текстовое содержимое сноски.

Параметры

  • footnote_idintegerобязательный
  • textstringобязательный
update_hyperlink

Обновляет целевой URL существующей внешней гиперссылки. Аргументы: r_id: Идентификатор связи (например, "rId7"), который нужно обновить. new_url: Новый целевой URL.

Обновляет целевой URL существующей внешней гиперссылки. Аргументы: r_id: Идентификатор связи (например, "rId7"), который нужно обновить. new_url: Новый целевой URL.

Параметры

  • r_idstringобязательный
  • new_urlstringобязательный
update_image

Заменить двоичные данные существующего изображения на месте. Размеры изображения и его позиция в документе сохраняются. Аргументы: rId: Идентификатор связи изображения, которое нужно заменить. new_image_path: Абсолютный путь к новому файлу изображения на диске.

Заменить двоичные данные существующего изображения на месте. Размеры изображения и его позиция в документе сохраняются. Аргументы: rId: Идентификатор связи изображения, которое нужно заменить. new_image_path: Абсолютный путь к новому файлу изображения на диске.

Параметры

  • rIdstringобязательный
  • new_image_pathstringобязательный
update_paragraph

Обновить текст и/или стиль существующего абзаца. Аргументы: para_id: paraId обновляемого абзаца. text: Новое текстовое содержимое. Пустая строка оставляет текст без изменений. style: Новое имя стиля абзаца. Пустая строка оставляет стиль без изменений.

Обновить текст и/или стиль существующего абзаца. Аргументы: para_id: paraId обновляемого абзаца. text: Новое текстовое содержимое. Пустая строка оставляет текст без изменений. style: Новое имя стиля абзаца. Пустая строка оставляет стиль без изменений.

Параметры

  • para_idstringобязательный
  • textstring
  • stylestring
update_style

Обновляет свойства basedOn и/или next у существующего стиля. Аргументы: name: Имя стиля или styleId (без учёта регистра). based_on: Новый styleId для basedOn (заменяет существующий). next_style: Новый styleId для next (заменяет существующий).

Обновляет свойства basedOn и/или next у существующего стиля. Аргументы: name: Имя стиля или styleId (без учёта регистра). based_on: Новый styleId для basedOn (заменяет существующий). next_style: Новый styleId для next (заменяет существующий).

Параметры

  • namestringобязательный
  • based_onany
  • next_styleany
update_toc

Перегенерировать записи оглавления из текущих заголовков.

Перегенерировать записи оглавления из текущих заголовков.

Параметры

Без параметров.

validate_endnotes

Сопоставьте идентификаторы концевых сносок между document.xml и endnotes.xml.

Сопоставьте идентификаторы концевых сносок между document.xml и endnotes.xml.

Параметры

  • document_handlestring
validate_footnotes

Сверьте идентификаторы сносок между document.xml и footnotes.xml.

Сверьте идентификаторы сносок между document.xml и footnotes.xml.

Параметры

  • document_handlestring
validate_paraids

Проверьте уникальность paraId во всех частях документа.

Проверьте уникальность paraId во всех частях документа.

Параметры

  • document_handlestring
validate_template_data

Проверяет, что словарь данных покрывает все поля шаблона. Возвращает недостающие и лишние ключи.

Проверяет, что словарь данных покрывает все поля шаблона. Возвращает недостающие и лишние ключи.

Параметры

  • dataobjectобязательный
write_part

Заменяет часть DOCX на новый XML. Сначала проверяет корректность. ПРЕДУПРЕЖДЕНИЕ: Прямое манипулирование XML может повредить документ при неправильном использовании.

Заменяет часть DOCX на новый XML. Сначала проверяет корректность. ПРЕДУПРЕЖДЕНИЕ: Прямое манипулирование XML может повредить документ при неправильном использовании.

Параметры

  • part_pathstringобязательный
  • xmlstringобязательный
xpath_query

Выполняет XPath-запрос к любой части DOCX. Предварительно связанные пространства имён: w, w14, r, wp, a, mc. Примеры: xpath="//w:p" — все абзацы xpath="//w:t/text()" — весь текстовый контент xpath="//w:p[w:pPr/w:pStyle/@w:val='Heading1']" — абзацы с заголовком 1

Выполняет XPath-запрос к любой части DOCX. Предварительно связанные пространства имён: w, w14, r, wp, a, mc. Примеры: xpath="//w:p" — все абзацы xpath="//w:t/text()" — весь текстовый контент xpath="//w:p[w:pPr/w:pStyle/@w:val='Heading1']" — абзацы с заголовком 1

Параметры

  • xpathstringобязательный
  • partstring

Другие проверенные MCP-сервера

Google Analytics MCP

Google Analytics MCP

MCP сервер для Google Analytics: через Data API выполняет запросы к аккаунтам, отчётам и метрикам. Помогает маркетологам и аналитикам получать аналитику прямо в ИИ-ассистентах, без ручного сбора данных.

Python2706
aliyun/alibaba-cloud-ops-mcp-server

aliyun/alibaba-cloud-ops-mcp-server

официальный

MCP сервер для управления облачной инфраструктурой Alibaba Cloud через AI-ассистентов. Поддерживает ECS, VPC, RDS, OSS и Cloud Monitor, а также автоматический деплой приложений на EC2 с анализом ст...

Python125
samuelgursky/davinci-resolve-mcp

samuelgursky/davinci-resolve-mcp

MCP сервер для управления DaVinci Resolve Studio через официальный Scripting API. Дает AI-ассистентам полный доступ к функциям редактирования, медиапула, грейдинга, а также рендеру и анализу. Все операции безопасны для исходных медиа — изменения только в проекте.

Python1699
Ihor-Sokoliuk/MCP-SearXNG

Ihor-Sokoliuk/MCP-SearXNG

MCP сервер для приватного веб-поиска, подключающий любой SearXNG к AI-ассистентам. Поддерживает поиск с пагинацией, чтение URL, кеширование, фильтры времени и языка — всё без API-ключей и с сохране...

TypeScript1052
Firecrawl MCP

Firecrawl MCP

официальный

MCP сервер для поиска и скрапинга веб-страниц, превращающий живой интернет в чистые данные для ИИ-агентов. Поддерживает навигацию, клики и автономные исследования. Работает в облаке или локально.

JavaScript6989
blockrunai/blockrun-mcp

blockrunai/blockrun-mcp

официальный

BlockRun MCP — сервер реал-тайм данных для Claude: рынки, исследования, X/Twitter и крипто без API ключей. Оплата за вызов из USDC-кошелька, подходит трейдерам и аналитикам.

TypeScript475
© Каталог MCP, 2026. Все права защищены.
Проект не аффилирован с Anthropic и любыми упомянутыми продуктами.
Все названия и торговые марки принадлежат их владельцам.
Контакты для связи: hi@mcp-katalog.ru

Лука Никитин