doc-control 0.0.1__tar.gz

doc_control-0.0.1/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+build/
+dist/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Word / Office temp and lock files
+~$*
+*.tmp
+.~lock.*#
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+
+# Local test documents (never commit real manuscripts)
+/private/
+
+# claude-arsenal runtime state
+arsenal/session/surface_profile.json
+arsenal/session/rate_limits.json
+arsenal/session/budget_iterations.json
+arsenal/session/worktree_isolation
+arsenal/session/worktree_isolation.why
+arsenal/session/host_branch
+arsenal/session/rescue_refs
+/.claude/worktrees/
+.claude/skills/*/findings.md
+tmp/*-notes.md
+tmp/.arsenal-sessions/

doc_control-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

doc_control-0.0.1/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.5
+Name: doc-control
+Version: 0.0.1
+Summary: Deterministic, LLM-first control of Word documents: addresses, anchors, tracked-change batches and a safety layer.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# doc-control
+
+<p align="center">
+  <img src="docs/social-preview.png" width="100%" alt="doc-control: let AI agents edit Word documents safely. Deterministic .docx edits, every change a tracked change the writer can reject.">
+</p>
+
+> Status: **spec and plan approved** — implementation starting. See `status/specification.md` and `status/plan.md`.
+
+A deterministic tool that lets AI agents work on Word documents quickly,
+precisely and safely, ideally live in the Word window the writer has open.
+Every content change is a tracked change the writer can accept or reject.
+
+For anyone — writers and editors first — who wants an AI agent's help inside a
+Word document without a single silent change. Nothing to install yet; watch the
+repo for the first release.
+
+## Planned shape
+
+- **One core, two engines, one API**
+  - *File engine*: edits a closed `.docx` with the Python standard library only,
+    rewriting only the parts it touches.
+  - *Live engine*: controls the open Word (Windows/COM first, Mac later).
+- **Two front doors**: a CLI with JSON in/out, and an MCP server
+  (`doc-control mcp`, stdio) for Claude Desktop / Cowork and other MCP clients.
+- **Safety first**: lock-file and on-disk change detection, backup before every
+  write, verification, automatic restore, operation log with undo, and
+  `unintended_changes == 0` as a gate.
+- **No AI inside.** Judgment belongs to the agent; approval belongs to the writer.
+
+It will replace `docx-fixer`, whose rules become packs built on this tool, and
+serve `literary-critic` as its first downstream consumer.
+
+## MCP server
+
+`doc-control mcp` serves every operation as an MCP tool over stdio, one tool per
+operation (`para.move` becomes `para_move`), with the same JSON Schemas and the
+same response envelope as the CLI. It needs nothing beyond the package itself:
+
+```json
+{
+  "mcpServers": {
+    "doc-control": { "command": "uvx", "args": ["doc-control", "mcp"] }
+  }
+}
+```
+
+## Documents
+
+- [Initial research: tooling and risks](docs/research/01-tooling-and-risks.md)
+
+## Development
+
+This repo uses [claude-arsenal](https://github.com/nuncaeslupus/claude-arsenal)
+(spec-driven workflow, gated tasks in `arsenal/tasks/`). See `CLAUDE.md`.
+
+## Related projects
+
+Same author:
+
+- [claude-arsenal](https://github.com/nuncaeslupus/claude-arsenal) — a Claude Code skill and plugin marketplace: specs before code, failing tests first, gates with numbers.
+- [literary-critic](https://github.com/nuncaeslupus/literary-critic) — lets an LLM index, analyse and advise on a full novel manuscript the way a professional editor would; doc-control's first planned consumer.
+- [drawspec](https://github.com/nuncaeslupus/drawspec) — declarative diagram spec → clean, themeable SVG; JSON with no coordinates, so an LLM can write it.
+- [integral-job-search](https://github.com/nuncaeslupus/integral-job-search) — a candidate-centred job search run as a conversation in Claude Code.
+
+## License
+
+[Apache-2.0](LICENSE)

doc_control-0.0.1/README.md

@@ -0,0 +1,67 @@
+# doc-control
+
+<p align="center">
+  <img src="docs/social-preview.png" width="100%" alt="doc-control: let AI agents edit Word documents safely. Deterministic .docx edits, every change a tracked change the writer can reject.">
+</p>
+
+> Status: **spec and plan approved** — implementation starting. See `status/specification.md` and `status/plan.md`.
+
+A deterministic tool that lets AI agents work on Word documents quickly,
+precisely and safely, ideally live in the Word window the writer has open.
+Every content change is a tracked change the writer can accept or reject.
+
+For anyone — writers and editors first — who wants an AI agent's help inside a
+Word document without a single silent change. Nothing to install yet; watch the
+repo for the first release.
+
+## Planned shape
+
+- **One core, two engines, one API**
+  - *File engine*: edits a closed `.docx` with the Python standard library only,
+    rewriting only the parts it touches.
+  - *Live engine*: controls the open Word (Windows/COM first, Mac later).
+- **Two front doors**: a CLI with JSON in/out, and an MCP server
+  (`doc-control mcp`, stdio) for Claude Desktop / Cowork and other MCP clients.
+- **Safety first**: lock-file and on-disk change detection, backup before every
+  write, verification, automatic restore, operation log with undo, and
+  `unintended_changes == 0` as a gate.
+- **No AI inside.** Judgment belongs to the agent; approval belongs to the writer.
+
+It will replace `docx-fixer`, whose rules become packs built on this tool, and
+serve `literary-critic` as its first downstream consumer.
+
+## MCP server
+
+`doc-control mcp` serves every operation as an MCP tool over stdio, one tool per
+operation (`para.move` becomes `para_move`), with the same JSON Schemas and the
+same response envelope as the CLI. It needs nothing beyond the package itself:
+
+```json
+{
+  "mcpServers": {
+    "doc-control": { "command": "uvx", "args": ["doc-control", "mcp"] }
+  }
+}
+```
+
+## Documents
+
+- [Initial research: tooling and risks](docs/research/01-tooling-and-risks.md)
+
+## Development
+
+This repo uses [claude-arsenal](https://github.com/nuncaeslupus/claude-arsenal)
+(spec-driven workflow, gated tasks in `arsenal/tasks/`). See `CLAUDE.md`.
+
+## Related projects
+
+Same author:
+
+- [claude-arsenal](https://github.com/nuncaeslupus/claude-arsenal) — a Claude Code skill and plugin marketplace: specs before code, failing tests first, gates with numbers.
+- [literary-critic](https://github.com/nuncaeslupus/literary-critic) — lets an LLM index, analyse and advise on a full novel manuscript the way a professional editor would; doc-control's first planned consumer.
+- [drawspec](https://github.com/nuncaeslupus/drawspec) — declarative diagram spec → clean, themeable SVG; JSON with no coordinates, so an LLM can write it.
+- [integral-job-search](https://github.com/nuncaeslupus/integral-job-search) — a candidate-centred job search run as a conversation in Claude Code.
+
+## License
+
+[Apache-2.0](LICENSE)

doc_control-0.0.1/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "doc-control"
+version = "0.0.1"
+description = "Deterministic, LLM-first control of Word documents: addresses, anchors, tracked-change batches and a safety layer."
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.11"
+dependencies = []
+
+[project.scripts]
+doc-control = "doc_control.cli:main"
+
+[dependency-groups]
+dev = ["pytest>=8", "pytest-cov>=5", "ruff>=0.6", "mypy>=1.11"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/doc_control"]
+
+[tool.hatch.build.targets.sdist]
+# Without this the sdist ships the agent tooling and planning files (.claude, arsenal, status).
+include = ["/src", "/tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["claude-arsenal", ".claude", "arsenal"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    "RUF", # ruff-specific
+    "B",   # flake8-bugbear (real bug patterns)
+    "SIM", # flake8-simplify (cleaner equivalents)
+    "PTH", # flake8-use-pathlib (prefer Path.open over open)
+]
+
+[tool.ruff.lint.per-file-ignores]
+# The test helpers hold OOXML namespace URIs and content types as long literals.
+"tests/helpers.py" = ["E501"]
+"tests/ops/test_stylesets.py" = ["E501"]  # the style-sheet fixture is one long XML literal
+
+[tool.mypy]
+python_version = "3.11"
+files = ["src", "tests"]
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+show_error_codes = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+# Wall-clock budgets are opt-in (`make bench`); a later `-m bench` overrides this default.
+addopts = "--strict-markers -m 'not bench'"
+markers = [
+    "bench: wall-clock performance budgets; run with `make bench` (pytest -m bench)",
+    "writes_invalid_docs: the test writes deliberately invalid packages; CI skips them in the OOXML lint",
+]

doc_control-0.0.1/src/doc_control/__init__.py

@@ -0,0 +1,4 @@
+"""doc-control: deterministic, LLM-first control of Word documents."""
+
+__version__ = "0.0.1"
+API_VERSION = "1.0"

doc_control-0.0.1/src/doc_control/__main__.py

@@ -0,0 +1,3 @@
+from doc_control.cli import main
+
+raise SystemExit(main())

doc_control-0.0.1/src/doc_control/cli.py

@@ -0,0 +1,93 @@
+"""Command-line front door: `doc-control <op> [--json '<request>' | --json - < request.json]`.
+
+`doc-control help <op>` is shorthand for `doc-control help --json '{"op": "<op>"}'`, and
+`--help` / `-h` are aliases of `help`. `doc-control mcp` serves the same operations as an
+MCP server on stdio (see `doc_control.mcp`).
+
+Never prompts and never reads stdin unless asked with `--json -`, so an agent whose
+stdin is an open pipe cannot hang it. Prints exactly one JSON envelope on stdout. Exit codes:
+0 success, 1 operation error, 2 usage error (unknown op or invalid request).
+"""
+
+from __future__ import annotations
+
+import json
+import sys
+from typing import Any
+
+from doc_control.envelope import Reply, failure, success
+from doc_control.errors import DocControlError, ErrorCode
+from doc_control.registry import Operation, load_operations
+
+_USAGE_CODES = {ErrorCode.SCHEMA_INVALID}
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = sys.argv[1:] if argv is None else argv
+    registry = load_operations()
+    op = args[0] if args else "help"
+    if op == "mcp":
+        from doc_control.mcp import serve
+
+        return serve()
+    if op in ("--version", "version"):
+        op = "capabilities"
+    elif op in ("--help", "-h"):
+        op = "help"
+    rest = args[1:]
+    try:
+        if op == "help" and len(rest) == 1 and not rest[0].startswith("-"):
+            request: dict[str, Any] = {"op": rest[0]}
+        else:
+            request = _read_request(rest)
+    except DocControlError as err:
+        envelope, code = failure(op, err), 2
+    else:
+        envelope, code = execute(registry, op, request)
+    print(json.dumps(envelope, ensure_ascii=False))
+    return code
+
+
+def execute(
+    registry: dict[str, Operation], op: str, request: dict[str, Any]
+) -> tuple[dict[str, Any], int]:
+    """Run one operation; return its envelope and the CLI exit code. Never raises."""
+    try:
+        if op not in registry:
+            raise DocControlError(ErrorCode.SCHEMA_INVALID, f"unknown operation: {op}", op=op)
+        out = registry[op].run(request)
+        if isinstance(out, Reply):
+            return success(
+                op, out.result, doc=out.doc, warnings=out.warnings, next_cursor=out.next_cursor
+            ), 0
+        return success(op, out), 0
+    except DocControlError as err:
+        return failure(op, err), 2 if err.code in _USAGE_CODES else 1
+    except Exception as err:  # never leak a traceback instead of an envelope
+        internal = DocControlError(ErrorCode.INTERNAL, f"{type(err).__name__}: {err}")
+        return failure(op, internal), 1
+
+
+def _read_request(rest: list[str]) -> dict[str, Any]:
+    raw: str | None = None
+    if rest[:1] == ["--json"]:
+        if len(rest) < 2:
+            raise DocControlError(ErrorCode.SCHEMA_INVALID, "--json needs a value")
+        raw = sys.stdin.read() if rest[1] == "-" else rest[1]
+        if len(rest) > 2:
+            raise DocControlError(ErrorCode.SCHEMA_INVALID, f"unexpected arguments: {rest[2:]}")
+    elif rest:
+        raise DocControlError(ErrorCode.SCHEMA_INVALID, f"unexpected arguments: {rest}")
+    if not raw or not raw.strip():
+        return {}
+    try:
+        value = json.loads(raw)
+    except json.JSONDecodeError as err:
+        raise DocControlError(ErrorCode.SCHEMA_INVALID, f"request is not JSON: {err}") from err
+    if not isinstance(value, dict):
+        raise DocControlError(ErrorCode.SCHEMA_INVALID, "request must be a JSON object")
+    return value
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

doc_control-0.0.1/src/doc_control/envelope.py

@@ -0,0 +1,40 @@
+"""The response envelope every operation returns."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any
+
+from doc_control import API_VERSION
+from doc_control.errors import DocControlError
+
+
+@dataclass(frozen=True)
+class Reply:
+    """What a handler returns when it fills more of the envelope than ``result``."""
+
+    result: dict[str, Any]
+    doc: dict[str, Any] | None = None
+    warnings: list[str] = field(default_factory=list)
+    next_cursor: str | None = None
+
+
+def success(
+    op: str,
+    result: dict[str, Any],
+    *,
+    doc: dict[str, Any] | None = None,
+    warnings: list[str] | None = None,
+    next_cursor: str | None = None,
+) -> dict[str, Any]:
+    out: dict[str, Any] = {"api": API_VERSION, "ok": True, "op": op}
+    if doc is not None:
+        out["doc"] = doc
+    out["result"] = result
+    out["warnings"] = warnings or []
+    out["next"] = next_cursor
+    return out
+
+
+def failure(op: str, error: DocControlError) -> dict[str, Any]:
+    return {"api": API_VERSION, "ok": False, "op": op, "error": error.to_dict()}

doc_control-0.0.1/src/doc_control/errors.py

@@ -0,0 +1,72 @@
+"""Stable error codes, each with a one-line hint on what to do next."""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Any
+
+
+class ErrorCode(StrEnum):
+    DOC_NOT_FOUND = "DOC_NOT_FOUND"
+    NOT_A_DOCX = "NOT_A_DOCX"
+    DOC_LOCKED = "DOC_LOCKED"
+    DOC_CHANGED_ON_DISK = "DOC_CHANGED_ON_DISK"
+    SCHEMA_INVALID = "SCHEMA_INVALID"
+    ADDRESS_INVALID = "ADDRESS_INVALID"
+    STALE_ADDRESS = "STALE_ADDRESS"
+    ANCHOR_NOT_FOUND = "ANCHOR_NOT_FOUND"
+    ANCHOR_AMBIGUOUS = "ANCHOR_AMBIGUOUS"
+    UNSUPPORTED_CONTENT = "UNSUPPORTED_CONTENT"
+    BATCH_CONFLICT = "BATCH_CONFLICT"
+    VERIFY_FAILED_RESTORED = "VERIFY_FAILED_RESTORED"
+    COMMENT_NOT_FOUND = "COMMENT_NOT_FOUND"
+    STYLE_NOT_FOUND = "STYLE_NOT_FOUND"
+    STYLE_CONFLICT = "STYLE_CONFLICT"
+    RECIPE_INVALID = "RECIPE_INVALID"
+    HISTORY_NOT_FOUND = "HISTORY_NOT_FOUND"
+    INTERNAL = "INTERNAL"
+
+
+HINTS: dict[ErrorCode, str] = {
+    ErrorCode.DOC_NOT_FOUND: "Check the path; it is resolved relative to the current directory.",
+    ErrorCode.NOT_A_DOCX: "Pass a Word .docx file; .doc and other formats are not supported.",
+    ErrorCode.DOC_LOCKED: "Word has the file open: save and close it in Word, then retry.",
+    ErrorCode.DOC_CHANGED_ON_DISK: "The file changed since you read it: re-read, then retry.",
+    ErrorCode.SCHEMA_INVALID: "Run `doc-control help <op>` to see the request schema.",
+    ErrorCode.ADDRESS_INVALID: "Use an address from a read result, e.g. p142#a7b2c3d4.",
+    ErrorCode.STALE_ADDRESS: "Re-read the paragraph (para.get) or resolve its anchor, then retry.",
+    ErrorCode.ANCHOR_NOT_FOUND: "Widen the quote or its context, or search with find.",
+    ErrorCode.ANCHOR_AMBIGUOUS: "Pick one of the candidates, or add prefix/suffix context.",
+    ErrorCode.UNSUPPORTED_CONTENT: (
+        "Edit around fields, hyperlinks or controls; encrypted or ZIP64 packages are not"
+        " supported: save a normal copy in Word."
+    ),
+    ErrorCode.BATCH_CONFLICT: "Split overlapping operations into separate batches.",
+    ErrorCode.VERIFY_FAILED_RESTORED: "Nothing was changed; report the request that caused it.",
+    ErrorCode.COMMENT_NOT_FOUND: "List comments with comments.list and use an existing id.",
+    ErrorCode.STYLE_NOT_FOUND: "List styles with styles.list and use an existing id.",
+    ErrorCode.STYLE_CONFLICT: "Rename the style or merge it with style.merge.",
+    ErrorCode.RECIPE_INVALID: "Fix the recipe so it only uses the documented keys.",
+    ErrorCode.HISTORY_NOT_FOUND: "List history with history.list and use an existing op id.",
+    ErrorCode.INTERNAL: "Unexpected error; nothing was written. Report it with the request.",
+}
+
+
+class DocControlError(Exception):
+    """An error with a stable code; the CLI turns it into an error envelope."""
+
+    def __init__(self, code: ErrorCode, message: str, **details: Any) -> None:
+        super().__init__(message)
+        self.code = code
+        self.message = message
+        self.details = details
+
+    def to_dict(self) -> dict[str, Any]:
+        out: dict[str, Any] = {
+            "code": self.code.value,
+            "message": self.message,
+            "hint": HINTS[self.code],
+        }
+        if self.details:
+            out["details"] = self.details
+        return out