safe-docx
Safe DOCX Suite
English | Español | 简体中文 | Português (Brasil) | Deutsch
safe-docx от UseJunior — используйте агентов кодирования и для работы с документами.
Часть инструментов разработчика UseJunior.
Safe Docx — это TypeScript-стек с открытым исходным кодом для точечного редактирования существующих файлов Microsoft Word .docx. Он создан для рабочих процессов, где агент предлагает изменения, а человеку по-прежнему требуется надежное редактирование документа с сохранением форматирования.
Если вы проверяете контракты с помощью ИИ, самым медленным этапом часто является применение принятых рекомендаций в Word. Safe Docx превращает это в детерминированные вызовы инструментов.
Зачем это нужно
CLI для ИИ-кодинга отлично работают с кодом и текстовыми файлами, но слабы в редактировании существующих (brownfield) файлов .docx. Бизнес- и юридические процессы по-прежнему завязаны на документах Word, поэтому мы создали нативный TypeScript-путь для:
чтения и поиска в существующих документах в форматах, эффективных с точки зрения токенов
выполнения точечных правок без нарушения форматирования
создания чистых/отслеживаемых результатов и артефактов извлечения правок
Миссия: позволить агентам кодирования заниматься и бумажной работой. Safe Docx фокусируется на детерминированных правках существующих файлов Word, где форматирование и семантика проверки должны сохраняться при автоматизации.
Related MCP server: docx-mcp
Позиционирование
Safe Docx оптимизирован для рабочих процессов агентов, которым требуются детерминированные, локальные правки существующих файлов .docx:
типизированные инструменты MCP для редактирования, сравнения, извлечения правок, комментариев, сносок и макета
проверяемое поведение с доказательствами тестирования и артефактами прослеживаемости
распространение среды выполнения TypeScript без необходимости использования Python или LibreOffice для поддерживаемого использования
Safe Docx не предназначен для замены библиотек для генерации .docx с нуля.
Нам доверяют
Юридическая фирма из топ-10 Am Law — многоэтапный конвейер перевода контрактов
Региональная фирма со 150 юристами — обработано более 22 млн токенов разметки контрактов
Gemini CLI — совместимое расширение MCP для редактирования Word
С чего начать
npx -y @usejunior/safe-docxПодробную информацию о настройке и справочник инструментов см. в packages/docx-mcp/README.md.
Пример: Агент редактирует контракт
Когда вы даете задание агенту кодирования (Claude Code, Cursor, Gemini CLI) с установленным Safe Docx, агент делает вызовы инструментов MCP, подобные этим:
User: Edit the NDA at ~/docs/NDA.docx — change the governing law
from "State of New York" to "State of Delaware" and save both
a clean copy and a tracked-changes copy.
Agent calls:
1. read_file(file_path="~/docs/NDA.docx", format="toon")
→ Returns paragraphs with stable IDs: _bk_1, _bk_2, ...
2. grep(file_path="~/docs/NDA.docx", pattern="State of New York")
→ Match in paragraph _bk_47
3. replace_text(
file_path="~/docs/NDA.docx",
target_paragraph_id="_bk_47",
old_string="State of New York",
new_string="State of Delaware",
instruction="Change governing law to Delaware"
)
4. save(
file_path="~/docs/NDA.docx",
save_to_local_path="~/docs/NDA-clean.docx",
tracked_save_to_local_path="~/docs/NDA-tracked.docx",
save_format="both"
)Агент автоматически обрабатывает вызовы инструментов. Вы получаете чистый файл и файл с отслеживаемыми изменениями для проверки человеком.
Быстрый старт MCP
Claude Code
claude mcp add safe-docx -- npx -y @usejunior/safe-docxClaude Desktop
Добавьте в ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) или %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"safe-docx": {
"command": "npx",
"args": ["-y", "@usejunior/safe-docx"]
}
}
}Gemini CLI
{
"mcpServers": {
"safe-docx": {
"command": "npx",
"args": ["-y", "@usejunior/safe-docx"]
}
}
}Любой клиент MCP
Команда:
npxАргументы:
["-y", "@usejunior/safe-docx"]Транспорт: stdio
Для чего оптимизирован Safe Docx
Редактирование существующих файлов
.docxЗамена текста и вставка абзацев с сохранением форматирования
Рабочие процессы с комментариями и сносками
Вывод результатов с отслеживаемыми изменениями для проверки (
download,compare_documents)Извлечение правок в виде структурированного JSON (
extract_revisions)
Для чего Safe Docx НЕ оптимизирован
Safe Docx — это не инструментарий для создания документов с нуля.
Если ваша основная потребность — создание новых файлов .docx из шаблонов/программной верстки, используйте пакеты, такие как docx.
Локальная среда выполнения Safe Docx также намеренно пока отклоняет файлы шаблонов Word (.dotx). Преобразуйте шаблон в обычный документ .docx перед открытием здесь.
Семейства документов
Автоматизированное покрытие фикстур в этом репозитории
Фикстуры взаимного NDA в стиле Common Paper
Фикстура взаимного NDA Bonterms
Фикстура письма о намерениях (LOI)
Фикстуры правок соглашений об ограниченном партнерстве ILPA
Разработано для сложных юридических и бизнес-классов .docx
Финансовые формы NVCA
YC SAFE
Инвестиционные меморандумы
Формы заказов и соглашения об оказании услуг
Соглашения об ограниченном партнерстве
Пакеты
@usejunior/docx-core: примитивы + движок сравнения для существующих документов.docx@usejunior/docx-mcp: реализация сервера MCP и интерфейс инструментов@usejunior/safe-docx: каноническое имя установки для конечного пользователя (npx -y @usejunior/safe-docx)@usejunior/safedocx-mcpb: приватный оберточный пакет MCP
Надежность и поверхность доверия
Схемы инструментов генерируются из
packages/docx-mcp/src/tool_catalog.ts.Матрица прослеживаемости OpenSpec:
packages/docx-mcp/src/testing/SAFE_DOCX_OPENSPEC_TRACEABILITY.mdМатрица допущений:
packages/docx-mcp/assumptions.mdРуководство по соответствию:
docs/safe-docx/sprint-3-conformance.md
Часто задаваемые вопросы
Что такое Safe Docx?
TypeScript-стек для редактирования DOCX, предназначенный для рабочих процессов агентов кодирования, которым требуются детерминированные правки существующих документов Word с сохранением форматирования.
Сохраняется ли форматирование при правках?
Это основная цель дизайна. Интерфейс инструментов построен вокруг хирургических операций (replace_text, insert_paragraph, элементы управления макетом), которые максимально сохраняют структуру документа и семантику форматирования.
Требуется ли .NET, Python или LibreOffice при обычном использовании?
Нет. Поддерживаемое использование среды выполнения — JavaScript/TypeScript с jszip + @xmldom/xmldom.
Можно ли генерировать контракты с нуля?
Это не является основной задачей. Для генерации с нуля используйте пакеты, такие как docx.
На каких типах документов это тестировалось в фикстурах репозитория?
Взаимные NDA (включая фикстуры в стиле Common Paper/Bonterms), письма о намерениях и фикстуры правок соглашений об ограниченном партнерстве ILPA.
Это только для юристов?
Нет. Те же проблемы редактирования существующих .docx возникают в HR, закупках, финансах, операционном отделе продаж и других процессах, насыщенных бумажной работой.
С чего мне начать как пользователю MCP?
Используйте @usejunior/safe-docx через npx, затем следуйте примерам настройки в packages/docx-mcp/README.md.
Где можно изучить схемы инструментов?
См. сгенерированный справочник в packages/docx-mcp/docs/tool-reference.generated.md.
Разработка
npm ci
npm run build
npm run lint --workspaces --if-present
npm run test:run
npm run check:spec-coverage
npm run test:coverage:packages
npm run coverage:packages:check
npm run coverage:matrixСм. также
Open Agreements — заполнение стандартных юридических шаблонов с помощью агентов кодирования (NDA, SAFE, NVCA)
Инструменты разработчика UseJunior — страница продукта с вариантами установки и каталогом инструментов
Конфиденциальность
Safe Docx работает полностью на вашем локальном компьютере. Содержимое документов не отправляется на внешние серверы. Подробности см. в нашей Политике конфиденциальности.
Управление
Available Tools
30 toolsaccept_ai_editsADestructive
Selectively accept tracked changes by revision id or author in the in-memory session, leaving all other (e.g. third-party reviewer) revisions byte-untouched. This does not write file_path; call save to persist the mutation. Provide revision_ids (array of w:id values) to target specific revisions, or author to accept every revision by one actor. Sweeps document.xml and supported side-story parts (footnotes, endnotes, comments). An ambiguous overlap — a targeted revision structurally containing, or contained by, a non-targeted revision (nested ins/del/move) — hard-errors with code AMBIGUOUS_REVISION_OVERLAP and a structured overlaps list unless normalize_first is set (best-effort, no byte-identical promise).
Inputs: file_path (required), author, revision_ids, normalize_first.
accept_changesBDestructive
Accept every supported tracked change in the document body, including inserted and deleted table-row revisions. Returns acceptance stats; unresolvedRowRevisions remains 0 for supported row markers.
Inputs: file_path (required).
add_commentADestructive
Add a comment or threaded reply to a document. Provide target_paragraph_id + anchor_text for root comments, or parent_comment_id for replies. Supports DOCX and ODT (ODT backs comments with office:annotation; threaded replies are DOCX-only). Surface: revisionable + package-mutation — the body-story comment reference is tracked (w:ins), while comment text and author metadata are recorded in the save report non-revision change manifest.
Inputs: text (required), author (required), file_path (required), initials, +3 more.
add_footnoteADestructive
Add a footnote anchored to a paragraph. Optionally position the reference after specific text using after_text. Note: [^N] markers in read_file output are display-only and not part of the editable text used by replace_text. Surface: revisionable + package-mutation — the footnote reference and note text are tracked (w:ins), while footnote-part creation and registration are recorded in the save report non-revision change manifest.
Inputs: text (required), file_path (required), target_paragraph_id (required), after_text.
batch_editADestructive
Single-agent front door for applying multiple edit steps (replace_text, insert_paragraph) to a document in one call. Validates all steps first, rejects conflicts before applying anything, then executes valid steps sequentially. Two source-proven bonded heading/body insertions may share an anchor and position when both declare the same bonded_pair_id and distinct style_source_id values; unrelated same-slot inserts remain conflicts. Accepts inline steps or a plan_file_path JSON array. Surface: revisionable — every applied step emits native OOXML tracked changes.
Inputs: file_path (required), steps, plan_file_path.
clear_formattingADestructive
Clear specific run-level formatting (bold, italic, underline, highlight, color, font) from paragraphs. Surface: revisionable — clearing emits a native run-property-change revision (w:rPrChange).
Inputs: file_path (required), clear_bold, clear_font, clear_color, +4 more.
close_fileADestructive
Close an open file session, or close all sessions with explicit confirmation. Supports DOCX, ODT, and Google Docs.
Inputs: confirm, clear_all, file_path, google_doc_id.
compare_documentsARead-only
Compare two documents and produce a tracked-changes output document. Provide original_file_path + revised_file_path for standalone comparison, or file_path to compare session edits against the original. DOCX and ODF (.odt) support both modes. DOCX output always uses the revised archive as its package base and publishes tagged revisions; engine, strategy, reconstruction, premerge, and refinement selectors are not exposed. DOCX stats count insertions/deletions as contiguous ranges, expose tagged-token-v1 totals as insertedAtoms/deletedAtoms with atomMetricVersion, report formatChanges separately from modifiedParagraphs, and report detected moves as moves/movedParagraphs with moveFromRanges/moveToRanges (moved content is not also counted as insertions or deletions, so a pure move reports moves > 0 with zero insertions/deletions). When a DOCX input difference is preserved in the output without tracked-change markup (for example a removed section's header or footer, or an unsupported header/footer topology), the response includes unrepresented_changes (objects with scope, kind, sectionIndex, for header/footer scopes role, and for the contentControl scope a contentControl identity: a changed w:sdtPr/w:sdtEndPr is published as the revised properties without markup, because CT_SdtPr admits no revision elements) plus one warnings string per entry, and the message carries a WARNING. Both fields are absent when no reportable unrepresented change was detected; the detector covers section properties, selected header/footer stories and content-control properties, so absence is not a guarantee about differences outside that scope. ODF compares at inline granularity (a modified paragraph is marked up in place — only the changed spans are struck or inserted).
Inputs: save_to_local_path (required), author, file_path, compare_moves, +4 more.
convert_to_odtA
Convert a DOCX document to OpenDocument Text (.odt) using the native model-to-model converter (no LibreOffice involved). Writes the .odt (default: source path with the .odt extension), validates ODF packaging safety before writing, and returns the output path plus a lossiness summary itemizing every downgraded construct. Conversion is semantic and intentionally lossy: text, headings, bold/italic/underline, hyperlinks, lists, and tables are mapped; richer styling, tracked changes, comments, and headers/footers are not. DOCX in, ODT out — Google Docs and .odt inputs are not supported.
Inputs: file_path, output_path, allow_overwrite.
delete_commentADestructive
Delete a comment and all its threaded replies from the document. Cascade-deletes all descendants. Surface: revisionable + package-mutation — the body-story comment reference removal is tracked (w:del), while comment/reply text cleanup is recorded in the save report non-revision change manifest.
Inputs: file_path (required), comment_id (required).
delete_footnoteADestructive
Delete a footnote and its reference from the document. Surface: revisionable — the reference and note text are removed as native OOXML tracked deletions (w:del).
Inputs: note_id (required), file_path (required).
exportA
Export a document to a portable rendering (Markdown, semantic HTML, or plain text). Writes an output file (default: source path with the format extension, e.g. .md, .html, or .txt) and returns its path, byte count, and the rendered content (under content). Intentionally lossy (no round-trip); HTML is the semantic tier, not pixel-faithful. DOCX only — Google Docs is not supported.
Inputs: format, file_path, output_path, allow_overwrite, +1 more.
extract_revisionsARead-only
Extract tracked changes as structured JSON with before/after text per paragraph, revision details, and comments. Table rows inserted or deleted as a whole, and row property changes (w:trPr > w:ins / w:del / w:trPrChange), are reported as records with scope "row", keyed by the row's first paragraph, whose revisions are ROW_INSERTION / ROW_DELETION / FORMAT_CHANGE entries carrying the revision id, author and date. Supports pagination via offset and limit. Read-only - does not modify the document.
Inputs: file_path (required), limit, offset.
format_layoutADestructive
Apply layout controls (paragraph spacing, paragraph alignment and pagination flags, table row height, cell padding). paragraph_properties sets alignment (w:jc) and sets (true) or removes (false) direct pageBreakBefore/keepNext/keepLines; requests that change nothing are no-ops. Google Docs supports paragraph spacing only. Surface: revisionable — DOCX geometry edits emit native property-change revisions (w:pPrChange/w:trPrChange/w:tcPrChange).
Inputs: strict, file_path, row_height, cell_padding, +3 more.
format_numberingADestructive
Change one DOCX body paragraph’s direct numbering reference. Use remove=true to drop direct w:numPr, match_paragraph_id to adopt another paragraph’s explicit numbering, or num_id with ilvl to reference an existing numbering definition. This tool does not create numbering definitions or change style-inherited numbering. Effective edits emit a native w:pPrChange; identical requests are no-ops.
Inputs: target_paragraph_id (required), ilvl, num_id, remove, +3 more.
format_sectionADestructive
Partially update one DOCX section’s page-number restart, page dimensions/orientation, or margins using a zero-based section_index from get_sections. Effective calls emit one native w:sectPrChange and preserve section topology, page-number format, columns, break type, and header/footer references. Orientation is literal and does not automatically swap dimensions. This tool does not create sections or edit header/footer content.
Inputs: section_index (required), margins, file_path, page_size, +2 more.
get_commentsARead-only
Get all comments from the document with IDs, authors, dates, text, and anchored paragraph IDs. Range-anchored DOCX comments also expose optional end_paragraph_id, start_run_index, start_char_offset, end_run_index, and end_char_offset fields describing the covered span. Includes threaded replies (DOCX). Supports DOCX and ODT. Read-only.
Inputs: file_path (required).
get_document_outlineARead-only
Get a compact structural map of a document's headings (DOCX only). Each entry is {paragraph_id, text, level, source}, plus list_label (e.g. "Section 1.01") when the heading is numbered; Markdown puts the label before the text. Deterministic sources are word_style, list_metadata, and outline_level, selected in that precedence order and included by default. Heuristic sources are run_in_header, title_with_period, title_with_colon, title_caps_centered, and title_bare; set include_heuristic_headings=true to include them. JSON preserves levels 1-9; Markdown clamps visual ATX depth to 6. Read-only.
Inputs: format, file_path, include_heuristic_headings.
get_file_statusARead-only
Get file/session metadata including edit count, normalization stats, and cache info. Supports DOCX, ODT, and Google Docs.
Inputs: file_path, google_doc_id.
get_footnotesARead-only
Get all footnotes from the document with IDs, display numbers, text, and anchored paragraph IDs. Read-only.
Inputs: file_path (required).
get_sectionsARead-only
Read DOCX main-document sections in document order. Returns zero-based session-relative section_index values, paragraph/body boundary metadata, page numbering, page size, margins, and header/footer relationship references. Call again after any operation that changes section topology. Read-only.
Inputs: file_path, google_doc_id.
grepARead-only
Search paragraphs with regex. Use file_path for session-based search, file_paths for stateless multi-file search, or google_doc_id for Google Docs. ODT supported via file_path (single-file) only.
Inputs: pattern, patterns, file_path, file_paths, +8 more.
has_tracked_changesARead-only
Check whether the document body contains tracked-change markers (insertions, deletions, moves, and property-change records). Read-only.
Inputs: file_path (required).
insert_paragraphADestructive
Insert a paragraph before/after an anchor paragraph by paragraph id. DOCX responses include structural_warnings when the placement may slice a hierarchy, mismatch list levels, or renumber a list. Supports DOCX, ODT, and Google Docs. ODT paragraph ids remain stable within the session; new paragraphs receive monotonically allocated ids, and reopening renumbers stored document order. Surface: revisionable — DOCX insertions emit native OOXML tracked changes.
Inputs: new_string (required), instruction (required), positional_anchor_node_id (required), position, +3 more.
insert_section_breakADestructive
Insert a tracked DOCX section break after a stable direct-body paragraph. The new boundary preserves the containing section’s page setup and header/footer relationship references. The following section inherits current properties by default; set inherit_properties=false to reset non-relationship properties, and optionally provide page-number/page-size/margin overrides in new_section. Call get_sections again after success because section indexes change.
Inputs: break_type (required), paragraph_id (required), file_path, new_section, +1 more.
read_fileARead-only
Read document content (DOCX, ODT, or Google Doc). Output is token-limited (~14k tokens) by default with pagination metadata (has_more, next_offset). Use offset/limit to paginate.
Inputs: limit, format, offset, node_ids, +7 more.
reject_ai_editsADestructive
Selectively reject tracked changes by revision id or author in the in-memory session (restoring their pre-edit state), leaving all other revisions byte-untouched. This does not write file_path; call save to persist the mutation. Symmetric to accept_ai_edits: provide revision_ids or author, sweeps document.xml and supported side-story parts, and hard-errors on an ambiguous overlap (code AMBIGUOUS_REVISION_OVERLAP with a structured overlaps list) unless normalize_first is set.
Inputs: file_path (required), author, revision_ids, normalize_first.
replace_textADestructive
Replace text in a paragraph by provider paragraph id, preserving formatting where supported. Supports DOCX, ODT, and Google Docs. To delete an ordinary DOCX body paragraph, pass its complete visible text as old_string and an empty new_string; a clean save removes the paragraph and a tracked save keeps the deletion for review. Do not use this shortcut for paragraphs that carry section properties, are structurally required by a table cell, or own bookmark/comment anchors without inspecting the structure first. Surface: revisionable — DOCX edits emit native OOXML tracked changes (w:ins/w:del/w:rPrChange).
Inputs: new_string (required), old_string (required), instruction (required), target_paragraph_id (required), +3 more.
saveADestructive
Persist the current in-memory document session. For DOCX: saves clean and/or tracked changes output. For ODT: saves an .odt package. For Google Docs: checkpoint (default) returns revisionId, or snapshot exports as DOCX. Surface: revisionable — the save report lists both the AI revisions applied and a non-revision change manifest of any package-level mutations (comment/footnote side parts, relationships) that have no tracked-change wrapper.
Inputs: save_to_local_path (required), file_path, save_format, google_doc_id, +7 more.
update_footnoteADestructive
Update the text content of an existing footnote. Surface: revisionable — note-text changes emit native OOXML tracked changes (w:ins/w:del) inside the footnote body.
Inputs: note_id (required), new_text (required), file_path (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 30 tools
Most tools target a distinct resource+action (comments, footnotes, sections, formatting, revisions), and descriptions clarify the boundaries. The main overlap is accept_changes vs accept_ai_edits/reject_ai_edits and batch_edit vs insert_paragraph/replace_text, where an agent must read carefully to pick the right one.
Names are uniformly snake_case and overwhelmingly verb-first (add_comment, get_sections, format_section, delete_footnote), with clear resource suffixes. Minor deviations are bare verbs (save, grep, export) and a get_/read_ split for retrieval tools (read_file vs get_file_status/get_comments).
At 30 tools this is heavy, though the domain (DOCX/ODT/Google Docs editing with tracked changes, comments, footnotes, sections, conversion) genuinely justifies breadth. Some consolidation is plausible — four format_* tools and three accept/reject revision tools could be grouped — so it sits at the borderline.
Coverage is broad: read/search/outline, edit (batch and single-step), save/export/convert, comments and footnotes CRUD, section and formatting edits, plus accept/reject and revision extraction. Gaps are modest: no reject-all counterpart to accept_changes, no comment text update, and no table or header/footer content editing.
Maintenance
Related MCP Connectors
Document editing, AI writing, saved documents, DOCX downloads, PDF, STT, TTS and watermarking
Convert DOCX documents to and from PDF, TXT, HTML, ODT, JPG and RTF.
Convert, create and edit Word, PowerPoint, Excel and PDF documents from any AI agent.
PDF to Word that keeps the layout, merge, split, compress, OCR, PDF/A and more
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceA powerful Word document processing service based on FastMCP, enabling AI assistants to create, edit, and manage docx files with full formatting support. Preserves original styles when editing content.193-
- AlicenseBqualityDmaintenanceEnables comprehensive management of Microsoft Word documents with 30+ tools for reading, writing, formatting, template merging, image extraction, equation extraction, and style application.241MIT
- AlicenseAqualityBmaintenanceFill standard legal agreement templates (NDAs, SAFEs, NVCA docs, employment, cloud terms) and produce DOCX files.35,330 npm66Apache 2.0
- AlicenseAqualityDmaintenanceProvides comprehensive read/write access to Word documents, including comments, track changes, and reply threads.91MIT