Skip to main content

Automated DOCX Redlining Engine

Project description

Adeu: Track Changes for the LLM era

GitHub Repo stars PyPI version npm version Downloads MCP Compatible Smithery CI License: MIT

LLMs speak Markdown; reviewers speak "Track Changes."

Adeu is a docx ↔ LLM translator: a Model Context Protocol (MCP) server (Python and Node.js implementations) and accompanying SDKs that act as a Virtual DOM for Microsoft Word. It provides a two-way abstraction layer that lets AI agents freely edit document text without destroying the underlying formatting or complex DOCX XML.

While standard libraries like python-docx excel at generating documents from scratch, they fail at non-destructive redlining. Adeu solves this by translating .docx files into a token-efficient Markdown representation. This frees AI agents to focus entirely on document semantics instead of wasting tokens wrestling with OpenXML.

Adeu acts as an intelligent proxy, processing AI edits as safe, atomic transactions:

  1. Read: Translates the document (from disk or live Word) into LLM-friendly CriticMarkup with a Semantic Appendix of defined terms, cross-references, and likely typos. The agent starts with semantic structure, not raw data.
  2. Validate: Acts as a strict safety gate. It protects the document's integrity by automatically blocking ambiguous text matches or invalid structural changes before they touch the file.
  3. Apply: Translates the AI's text edits into native Word Track Changes. Adeu handles the complex XML under the hood, ensuring existing layouts, fonts, and margin comments are perfectly preserved.

Built and maintained by the team at Adeu.


Installation

Adeu can be installed directly into AI assistants as an MCP server, or used locally as a developer toolchain.

Claude Desktop

You can install Adeu directly into Claude Desktop using the official extension package:

  1. Download the latest Adeu.mcpb file from the GitHub Releases page.
  2. Open Claude Desktop and navigate to Settings > Extensions.
  3. Click Advanced settings and find the Extension Developer section.
  4. Click Install Extension..., select the downloaded .mcpb file, and follow the prompts.

Gemini CLI

Adeu is available as a native Gemini CLI extension. To install:

gemini extensions install https://github.com/dealfluence/adeu

Other MCP Clients (Cursor, Windsurf, etc.)

For IDEs or clients that configure MCP servers via JSON, you can use either the Node.js or Python backend:

Node.js

{
  "mcpServers": {
    "adeu": {
      "command": "npx",
      "args": ["-y", "@adeu/mcp-server"]
    }
  }
}

Python (Required for Live MS Word integration on Windows)

{
  "mcpServers": {
    "adeu": {
      "command": "uvx",
      "args": ["--from", "adeu", "adeu-server"]
    }
  }
}

Smithery

To install Adeu using the Smithery package manager:

npx -y @smithery/cli install adeu --client claude

Agent Workflows

Adeu provides agents with specific tools to read, review, and edit documents safely.

MCP Apps UI: The read_docx tool supports the MCP Apps UI protocol. When an agent reads a document, Adeu dynamically renders a custom, interactive Markdown view directly inside the chat window.

Recommended Agent Prompt: You can guarantee the best behavioral results by adding this context to your agent's system prompt or project instructions:

Role: Document Specialist Tools:

  • read_docx(clean_view=True): Read the final "clean" version of the text to understand context.
  • process_document_batch: Commit & Negotiate Mode. Apply a unified list of changes. Use type: "modify" for specific search-and-replace text edits, and type: "accept", "reject", or "reply" to manage existing Track Changes and Comments by ID.
  • finalize_document: Pre-Send Scrub. Strip dangerous metadata, author names, and internal tracking IDs, lock the document (protection_mode="read_only"), and prepare it for distribution.

Live MS Word Integration

If you are running on Windows with Microsoft Word installed, Adeu can act as a real-time copilot, editing the active document right in front of you. This requires running the Python MCP server backend (see Developer Tools below).


Developer Tools (Python & TypeScript)

If you are building a legal-tech application, an automated pipeline, or want to use the local CLI, use our SDKs.

The Python CLI

The Python toolchain is managed via uv.

pip install uv

# Extract clean text for RAG or prompting
uvx adeu extract contract.docx -o contract.md

# Generate a visual diff between two versions
uvx adeu diff v1.docx v2.docx

# Apply edits to the DOCX
uvx adeu apply contract.docx edits.json --author "Review Bot"

# Scrub author metadata and internal trackers
uvx adeu sanitize redline.docx -o clean.docx --keep-markup --author "My Firm" --report

The Python SDK

from adeu import RedlineEngine, ModifyText
from io import BytesIO

with open("MSA.docx", "rb") as f:
    stream = BytesIO(f.read())

edit = ModifyText(
    target_text="State of New York",
    new_text="State of Delaware",
    comment="Standardizing governing law."
)

engine = RedlineEngine(stream, author="AI Copilot")
engine.apply_edits([edit])

with open("MSA_Redlined.docx", "wb") as f:
    f.write(engine.save_to_stream().getvalue())

The TypeScript SDK

The entire core parsing and diffing engine is also available in pure TypeScript.

import { readFileSync, writeFileSync } from "fs";
import { DocumentObject, RedlineEngine } from "@adeu/core";

const buffer = readFileSync("MSA.docx");
const doc = await DocumentObject.load(buffer);

const engine = new RedlineEngine(doc, "AI Copilot");
engine.process_batch([{
  type: "modify",
  target_text: "State of New York",
  new_text: "State of Delaware",
  comment: "Standardizing governing law."
}]);

const outBuffer = await doc.save();
writeFileSync("MSA_Redlined.docx", outBuffer);

See the @adeu/core documentation for full installation and usage details.


Ecosystem & Integrations

Adeu is designed as a Virtual DOM for DOCX. Because we keep the core strictly focused on OpenXML safety, we maintain a dedicated ecosystem/ directory for third-party integrations.

In the ecosystem folder, you will find advanced workflows, wrappers, and tools built by the community and LegalTech vendors, including:

  • Legal validation and case-law routing before applying edits.
  • Contract Lifecycle Management (CLM) sync scripts.
  • Specialized multi-agent architectures (LangChain, AutoGen, etc.).

Are you a vendor or builder? We welcome PRs to the ecosystem folder! Please see our Vendor & Integration Policy to get started.


Adeu Cloud

By default, the core Adeu redlining engine and local file tools are fully open-source and execute entirely on your machine. Adeu never phones home with your local documents (though your chosen LLM provider will naturally process the text the agent reads).

However, you can explicitly opt-in to connect your MCP server to Adeu Cloud to unlock:

  • End-to-End Workflows (Email): Because contracts travel via email, Adeu Cloud allows agents to securely fetch email threads, extract counterparty DOCX attachments for review, and draft replies with your newly sanitized redlines attached.
  • Advanced Document Validation: Run complex, multi-document semantic validation tasks asynchronously. By securely routing these massive contexts to Adeu Cloud for processing, you prevent your local AI agent from exhausting its context window or hitting rate limits.

Learn more about Adeu Cloud.


Contributing

We welcome contributions from the community! Whether it's fixing bugs, adding capabilities, or improving documentation, please see our Contributing Guide for instructions on setting up the local uv environment, running tests, and understanding the project's strict XML safety guidelines.


License

MIT License. Open source and free to use in commercial applications.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adeu-1.7.4.tar.gz (367.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adeu-1.7.4-py3-none-any.whl (183.3 kB view details)

Uploaded Python 3

File details

Details for the file adeu-1.7.4.tar.gz.

File metadata

  • Download URL: adeu-1.7.4.tar.gz
  • Upload date:
  • Size: 367.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for adeu-1.7.4.tar.gz
Algorithm Hash digest
SHA256 296a84372329fbf3915eb1af5dfdcc3f50eb668806fc9adf865b390507dd508a
MD5 17978e239e7f6ef47c0855188a98e85e
BLAKE2b-256 57da64f6bc5e682a9caa1478b021df84a509ebb8e3d5cad6409d8ee8bbe3c9f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for adeu-1.7.4.tar.gz:

Publisher: release.yml on dealfluence/adeu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file adeu-1.7.4-py3-none-any.whl.

File metadata

  • Download URL: adeu-1.7.4-py3-none-any.whl
  • Upload date:
  • Size: 183.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for adeu-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 472876ca33bda61ce268057ab1f26d8ba7de5844e37660eb73eb2b8d3ced031c
MD5 2ca8314b72fb56ebb0c8585a1d095557
BLAKE2b-256 4c8dc8bd8f2593d2106d239f6328a52785d332a124fb8d32adab2f5c8c9e5c28

See more details on using hashes here.

Provenance

The following attestation bundles were made for adeu-1.7.4-py3-none-any.whl:

Publisher: release.yml on dealfluence/adeu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page