Skip to content
Back to search

adeu-skills

SkillGitHubIncomplete

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/dealfluence--adeu/badge.svg)](/listings/dealfluence--adeu)

HTML

<a href="/listings/dealfluence--adeu"><img src="/api/listings/dealfluence--adeu/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Adeu can be installed directly into AI assistants as an MCP server, used as a Claude Code plugin or Agent Skill, CLI tool, or used locally as a developer toolchain.

Claude Code (Plugin)

Adeu ships as a [Claude Code plugin](https://docs.claude.com/en/docs/claude-code/plugins) with a built-in agent skill that teaches Claude how to use the engine effectively. Inside Claude Code:

/plugin marketplace add dealfluence/adeu
/plugin install adeu-redlining@adeu-skills

For best results, also connect either the Node MCP server (`npx -y @adeu/mcp-server`) or the Python MCP server (`uvx --from "adeu[mcp]" adeu-server`). The plugin works without an MCP server too — it falls back to driving the `uvx adeu` CLI via Bash.

Other Skills-Compatible Agents (Cursor, Windsurf, VS Code Copilot, etc.)

Adeu's redlining skill follows the open [Agent Skills specification](https://agentskills.io) and works with any compatible agent:

npx skills add dealfluence/adeu

The skill installs to your agent's skills directory and activates automatically when you ask Claude to redline, edit, or review a `.docx` file.

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](https://github.com/dealfluence/adeu/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](https://geminicli.com/extensions/). 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[mcp]", "adeu-server"]
    }
  }
}

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 22 lines
  1. {
  2. "name": "adeu-skills",
  3. "owner": {
  4. "name": "Adeu Solutions",
  5. "url": "https://github.com/dealfluence/adeu"
  6. },
  7. "metadata": {
  8. "description": "Agentic tools for reviewing, redlining, and negotiating DOCX contracts."
  9. },
  10. "plugins": [
  11. {
  12. "name": "adeu-redlining",
  13. "description": "Professional DOCX Redlining: Track Changes, Comments, and Review Logic.",
  14. "version": "4.1.0",
  15. "source": "./",
  16. "homepage": "https://adeu.ai",
  17. "repository": "https://github.com/dealfluence/adeu",
  18. "license": "MIT",
  19. "skills": ["./skills/adeu-redlining"]
  20. }
  21. ]
  22. }
README.md · README · 255 lines
  1. # Adeu: Track Changes for the LLM era
  2. [![GitHub Repo stars](https://img.shields.io/github/stars/dealfluence/adeu?style=social)](https://github.com/dealfluence/adeu)
  3. [![PyPI version](https://img.shields.io/pypi/v/adeu.svg)](https://pypi.org/project/adeu/)
  4. [![npm version](https://img.shields.io/npm/v/@adeu/core.svg)](https://www.npmjs.com/package/@adeu/core)
  5. [![Downloads](https://img.shields.io/pepy/dt/adeu)](https://pepy.tech/project/adeu)
  6. [![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-green.svg)](https://modelcontextprotocol.io/)
  7. [![CI](https://github.com/dealfluence/adeu/actions/workflows/ci.yml/badge.svg)](https://github.com/dealfluence/adeu/actions/workflows/ci.yml)
  8. [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
  9. **LLMs speak Markdown; reviewers speak "Track Changes."**
  10. 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.
  11. 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.
  12. Adeu acts as an **intelligent proxy**, processing AI edits as safe, atomic transactions:
  13. 1. **Read:** Translates the document (from disk or live Word) into LLM-friendly **[CriticMarkup](https://fletcher.github.io/MultiMarkdown-6/syntax/critic.html)** with a **Semantic Appendix** of defined terms, cross-references, and likely typos. The agent starts with semantic structure, not raw data.
  14. 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.
  15. 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.
  16. Built and maintained by the team at [Adeu](https://adeu.ai).
  17. ---
  18. ## Installation
  19. Adeu can be installed directly into AI assistants as an MCP server, used as a Claude Code plugin or Agent Skill, CLI tool, or used locally as a developer toolchain.
  20. ### Claude Code (Plugin)
  21. Adeu ships as a [Claude Code plugin](https://docs.claude.com/en/docs/claude-code/plugins) with a built-in agent skill that teaches Claude how to use the engine effectively. Inside Claude Code:
  22. ```
  23. /plugin marketplace add dealfluence/adeu
  24. /plugin install adeu-redlining@adeu-skills
  25. ```
  26. For best results, also connect either the Node MCP server (`npx -y @adeu/mcp-server`) or the Python MCP server (`uvx --from "adeu[mcp]" adeu-server`). The plugin works without an MCP server too — it falls back to driving the `uvx adeu` CLI via Bash.
  27. ### Other Skills-Compatible Agents (Cursor, Windsurf, VS Code Copilot, etc.)
  28. Adeu's redlining skill follows the open [Agent Skills specification](https://agentskills.io) and works with any compatible agent:
  29. ```bash
  30. npx skills add dealfluence/adeu
  31. ```
  32. The skill installs to your agent's skills directory and activates automatically when you ask Claude to redline, edit, or review a `.docx` file.
  33. ### Claude Desktop
  34. You can install Adeu directly into Claude Desktop using the official extension package:
  35. 1. Download the latest `Adeu.mcpb` file from the [GitHub Releases](https://github.com/dealfluence/adeu/releases) page.
  36. 2. Open Claude Desktop and navigate to **Settings > Extensions**.
  37. 3. Click **Advanced settings** and find the Extension Developer section.
  38. 4. Click **Install Extension...**, select the downloaded `.mcpb` file, and follow the prompts.
  39. ### Gemini CLI
  40. Adeu is available as a native [Gemini CLI extension](https://geminicli.com/extensions/). To install:
  41. ```bash
  42. gemini extensions install https://github.com/dealfluence/adeu
  43. ```
  44. ### Other MCP Clients (Cursor, Windsurf, etc.)
  45. For IDEs or clients that configure MCP servers via JSON, you can use either the Node.js or Python backend:
  46. **Node.js**
  47. ```json
  48. {
  49. "mcpServers": {
  50. "adeu": {
  51. "command": "npx",
  52. "args": ["-y", "@adeu/mcp-server"]
  53. }
  54. }
  55. }
  56. ```
  57. **Python (Required for Live MS Word integration on Windows)**
  58. ```json
  59. {
  60. "mcpServers": {
  61. "adeu": {
  62. "command": "uvx",
  63. "args": ["--from", "adeu[mcp]", "adeu-server"]
  64. }
  65. }
  66. }
  67. ```
  68. ---
  69. ## Agent Workflows
  70. Adeu provides agents with specific tools to read, review, and edit documents safely.
  71. > **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.
  72. **Recommended Agent Prompt:**
  73. You can guarantee the best behavioral results by adding this context to your agent's system prompt or project instructions:
  74. > **Role:** Document Specialist
  75. > **Tools:**
  76. >
  77. > - `read_docx`: Start with `mode="changes"` to triage existing tracked changes (`Chg:N`) and comments (`Com:N`), `search_query` (with optional `page="4-5"` range) to locate specific clauses, `mode="fields"` to inspect form fields (`CC:<N>`), or `mode="outline"` followed by bounded page ranges (`page="1-8"`) to read sections without loading the whole file.
  78. > - `process_document_batch`: **Commit & Negotiate Mode.** Apply a unified, sequentially evaluated list of changes in one call: `type: "modify"` for search-and-replace text edits (supports Markdown headings/bold/italic/pipe tables, `{#cell:<id>}` empty-cell anchors, `match_mode="all"`, `regex=True`, and single or `[{"text": ..., "author": ...}]` comments), `type: "set_field"` for form fields, `type: "accept"`, `"reject"` (with optional `part`), or `"reply"` for existing markup, and `type: "insert_row"` / `"delete_row"` for table rows. Pass `markup_mode="manual"` when inline strikethrough/underline formatting is requested instead of Track Changes.
  79. > - `diff_docx_files`: Compare two `.docx` files; pass `output_path` and `author_name` to write the comparison as a tracked-changes `.docx` in one step.
  80. > - `finalize_document`: **Pre-Send Scrub.** Strip metadata, author names, and internal tracking IDs, lock the document (`protection_mode="read_only"`), and prepare it for distribution.
  81. ### Live MS Word Integration
  82. 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).
  83. ---
  84. ## Developer Tools (Python & TypeScript)
  85. If you are building a legal-tech application, an automated pipeline, or want to use the local CLI, use our SDKs.
  86. ### The Python CLI
  87. The Python toolchain is managed via [uv](https://docs.astral.sh/uv/).
  88. ```bash
  89. pip install uv
  90. uv tool install adeu
  91. # Extract clean text for RAG or prompting
  92. adeu extract contract.docx -o contract.md
  93. # Generate a visual diff between two versions
  94. adeu diff v1.docx v2.docx
  95. # Apply edits to the DOCX
  96. adeu apply contract.docx edits.json --author "Review Bot"
  97. # Apply valid edits in salvage mode while reporting failing edits
  98. adeu apply contract.docx edits.json --partial
  99. # High-throughput JSON-Lines daemon
  100. adeu serve
  101. # Scrub author metadata and internal trackers
  102. adeu sanitize redline.docx -o clean.docx --keep-markup --author "My Firm" --report
  103. ```
  104. What the text projection preserves exactly, what it normalizes (lists,
  105. styles, synthetic pages), and what stays read-only is specified in
  106. [docs/FIDELITY.md](docs/FIDELITY.md).
  107. ### The Python SDK
  108. ```python
  109. from adeu import RedlineEngine, ModifyText
  110. from io import BytesIO
  111. with open("MSA.docx", "rb") as f:
  112. stream = BytesIO(f.read())
  113. edit = ModifyText(
  114. target_text="State of New York",
  115. new_text="State of Delaware",
  116. comment="Standardizing governing law."
  117. )
  118. engine = RedlineEngine(stream, author="AI Copilot")
  119. engine.apply_edits([edit])
  120. with open("MSA_Redlined.docx", "wb") as f:
  121. f.write(engine.save_to_stream().getvalue())
  122. ```
  123. ### The TypeScript SDK
  124. The entire core parsing and diffing engine is also available in pure TypeScript.
  125. ```typescript
  126. import { readFileSync, writeFileSync } from "fs";
  127. import { DocumentObject, RedlineEngine } from "@adeu/core";
  128. const buffer = readFileSync("MSA.docx");
  129. const doc = await DocumentObject.load(buffer);
  130. const engine = new RedlineEngine(doc, "AI Copilot");
  131. engine.process_batch([{
  132. type: "modify",
  133. target_text: "State of New York",
  134. new_text: "State of Delaware",
  135. comment: "Standardizing governing law."
  136. }]);
  137. const outBuffer = await doc.save();
  138. writeFileSync("MSA_Redlined.docx", outBuffer);
  139. ```
  140. See the [@adeu/core documentation](https://github.com/dealfluence/adeu/tree/main/node/packages/core#readme) for full installation and usage details.
  141. ### n8n Community Node
  142. Adeu ships as an [n8n](https://n8n.io) community node (`n8n-nodes-adeu`) for teams who prefer visual workflow automation over code. It exposes the full engine (extract Markdown, apply tracked changes, generate diffs, and finalize documents) as drop-in nodes that work in both deterministic pipelines and AI Agent tool calls.
  143. ```bash
  144. # In n8n: Settings → Community Nodes → Install: n8n-nodes-adeu
  145. ```
  146. See the [n8n-nodes-adeu README](https://github.com/dealfluence/adeu/blob/main/node/packages/n8n-nodes-adeu/README.md) for installation, `$fromAI` recipes, and example workflows.
  147. ---
  148. ## LangChain Integration
  149. `langchain-adeu` is an official integration package that exposes Adeu's local, offline-capable document manipulation tools directly to the LangChain ecosystem.
  150. ```bash
  151. pip install langchain-adeu
  152. ```
  153. Bundle its capabilities as tools in your agent workflow:
  154. ```python
  155. from langchain_adeu import AdeuToolkit
  156. # Instantiate and retrieve all document tools
  157. tools = AdeuToolkit().get_tools()
  158. ```
  159. Refer to the [LangChain Workspace Guide](langchain/README.md) for full development instructions and detailed parameters.
  160. ---
  161. ## Ecosystem & Integrations
  162. Adeu is designed as a Virtual DOM for DOCX. Because we keep the core strictly focused on OpenXML safety, we maintain a dedicated [`ecosystem/`](ecosystem/) directory for third-party integrations.
  163. The ecosystem folder hosts policies and guidelines for third-party contributions such as legal validation workflows, CLM sync scripts, and specialized multi-agent architectures.
  164. **Are you a vendor or builder?** We welcome PRs to the ecosystem folder! Please see our [Vendor & Integration Policy](ecosystem/VENDOR_POLICY.md) to get started.
  165. ---
  166. ## Adeu Cloud
  167. 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).
  168. However, for teams requiring end-to-end workflows, you can connect to **Adeu Cloud** to unlock:
  169. - **Email Processing & Fetching:** We offer an extended MCP server with secure email thread fetching, document extraction, and automated drafting capabilities to handle contracts directly from your inbox.
  170. [Learn more about Adeu Cloud](https://adeu.ai).
  171. ---
  172. ## Contributing
  173. We welcome contributions from the community! Whether it's fixing bugs, adding capabilities, or improving documentation, please see our [Contributing Guide](CONTRIBUTING.md) for instructions on setting up the local `uv` environment, running tests, and understanding the project's strict XML safety guidelines.
  174. ---
  175. ## License
  176. MIT License. Open source and free to use in commercial applications.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.