mdcx 1.0.0__tar.gz

mdcx-1.0.0/.gitignore

@@ -0,0 +1,14 @@
+# Paquetes de corpus: llevan documentos dentro, cifrados, y no se versionan.
+*.mdcx
+
+# Carpetas de trabajo.
+Input/
+Output/
+
+__pycache__/
+*.pyc
+.venv/
+dist/
+build/
+*.egg-info/
+dist/

mdcx-1.0.0/CITATION.cff

@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+title: "mdcx: conversion verificada de expedientes documentales a Markdown consultable"
+message: "If you use this software in published work, please cite the entry below."
+type: software
+authors:
+  - family-names: Ellena
+    given-names: Jorge
+repository-code: "https://github.com/jorgell23-sys/mdcx"
+abstract: >-
+  Converts complete document collections to Markdown, checking each file against
+  the text the original actually exposes, packages the resulting corpus with its
+  index and provenance into a single encrypted file, and exposes it to agents
+  through the Model Context Protocol. Over a collection of 99 documents, answering
+  one query through the package costs 435 model tokens against the 2,265,488
+  required to read the originals.
+keywords:
+  - document conversion
+  - markdown
+  - retrieval
+  - model context protocol
+  - provenance
+license: Apache-2.0
+version: 1.0.0
+date-released: "2026-08-19"

mdcx-1.0.0/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.

mdcx-1.0.0/NOTICE

@@ -0,0 +1,33 @@
+mdcx
+Copyright 2026 Jorge Ellena G.
+
+This product includes software developed by Jorge Ellena G.
+
+Anyone redistributing this software, with or without modification, must retain this
+notice, as required by section 4 of the Apache 2.0 licence.
+
+HOW IT WAS WRITTEN
+
+Conceived and directed by Jorge Ellena G.; programmed with the assistance of Claude
+(Anthropic). Every design decision in this package was made against measurements over a
+real document collection, and those measurements are recorded alongside the decisions
+they justify.
+
+Copyright is held by Jorge Ellena G. Assistance from a tool does not create legal
+co-authorship, any more than a compiler or an editor does; it is declared here because it
+is accurate and because it is worth knowing how something one adopts was made.
+
+DEPENDENCIES
+
+The package relies on the following libraries, each under its own licence:
+
+  Docling y docling-core (IBM)          MIT
+  pypdfium2                             BSD-3-Clause / Apache-2.0
+  python-docx, openpyxl, python-pptx    MIT
+  onnxruntime, rapidocr-onnxruntime     MIT / Apache-2.0
+  cryptography                          Apache-2.0 / BSD-3-Clause
+  mcp (Model Context Protocol SDK)      MIT
+
+PyMuPDF was deliberately avoided: its AGPL-3.0 licence would require any program using
+it to be published under AGPL, including one offered only as a network service.
+pypdfium2 covers the same needs without that condition.

mdcx-1.0.0/PKG-INFO

@@ -0,0 +1,266 @@
+Metadata-Version: 2.5
+Name: mdcx
+Version: 1.0.0
+Summary: Convert document collections to verified Markdown, package them encrypted, and expose them to agents over MCP
+Project-URL: Homepage, https://github.com/jorgell23-sys/mdcx
+Project-URL: Repository, https://github.com/jorgell23-sys/mdcx
+Project-URL: Issues, https://github.com/jorgell23-sys/mdcx/issues
+Project-URL: Changelog, https://github.com/jorgell23-sys/mdcx/releases
+Author: Jorge Ellena G.
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: document-conversion,markdown,mcp,provenance,rag,retrieval
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Legal Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Text Processing :: Indexing
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: cryptography>=41.0
+Provides-Extra: all
+Requires-Dist: docling>=2.0; extra == 'all'
+Requires-Dist: mcp>=1.0; extra == 'all'
+Requires-Dist: onnxruntime>=1.16; extra == 'all'
+Requires-Dist: openpyxl>=3.1; extra == 'all'
+Requires-Dist: pypdfium2>=4.0; extra == 'all'
+Requires-Dist: python-docx>=1.0; extra == 'all'
+Requires-Dist: python-pptx>=1.0; extra == 'all'
+Requires-Dist: rapidocr-onnxruntime>=1.3; extra == 'all'
+Provides-Extra: convert
+Requires-Dist: docling>=2.0; extra == 'convert'
+Requires-Dist: openpyxl>=3.1; extra == 'convert'
+Requires-Dist: pypdfium2>=4.0; extra == 'convert'
+Requires-Dist: python-docx>=1.0; extra == 'convert'
+Requires-Dist: python-pptx>=1.0; extra == 'convert'
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == 'mcp'
+Provides-Extra: ocr
+Requires-Dist: onnxruntime>=1.16; extra == 'ocr'
+Requires-Dist: rapidocr-onnxruntime>=1.3; extra == 'ocr'
+Description-Content-Type: text/markdown
+
+# mdcx
+
+<!-- mcp-name: io.github.jorgell23-sys/mdcx -->
+
+Convert a document collection to verified Markdown, package it into a single
+encrypted file, and make it queryable by agents through the Model Context
+Protocol.
+
+## The problem
+
+An agent answering questions about a document collection has two options. It can
+receive the documents in its context window, which is expensive and bounded by
+the window size. Or it can query a component that already knows where each item
+is.
+
+Measuring one specific query — where the minimum pipe diameter to be modelled in
+3D is stated — over a real collection of 99 documents and 180 MB, using the
+cl100k_base tokenizer:
+
+| | Model tokens | Local tokens |
+|---|---|---|
+| Reading the originals | **2,265,488** | 2,265,327 |
+| Querying the package | **435** | 2,688,861 |
+
+The 435 comprise 20 for the question, 274 for the retrieved passage and 141 for
+the answer.
+
+The first row costs the entire collection for a concrete reason: a PDF cannot be
+searched, it is a binary, and without prior conversion there is no way to know
+which of the 99 documents holds the answer. They all have to be extracted and
+read.
+
+This is one measurement, not an average: the saving depends on how much text an
+answer requires. What does not vary is the shape of the change. The work does not
+disappear, it moves from the context window — which is billed and finite — to the
+CPU, which is not. That is why the local column rises rather than falls.
+
+## The three stages
+
+**Conversion.** Each document is converted to Markdown and checked against the
+text the original actually exposes, read with a library independent from the
+engine that performed the conversion. Content the structured engine omits is
+appended verbatim rather than reported as lost.
+
+Over the collection used during development — 99 documents, 1,144,553 reference
+words — 594 words were not recovered, a global coverage of 99.948%. Of the 184
+documents exposing text, 116 came out at exactly 100% and none below 99.5%. The
+remaining four are scanned drawings containing no text at all in the file: they
+were read by optical character recognition and are marked as unverifiable,
+because no text original exists to measure them against.
+
+**Packaging.** The corpus, its search index and the provenance of every passage
+fit into a single `.mdcx` file, encrypted with AES-256-GCM, whose header can be
+read without the key. From 8.8 MB of Markdown to 3.9 MB in one file.
+
+**Retrieval.** A query returns the passages that answer it with their exact
+source. Over the 20 real queries used for tuning, the correct document appears
+within the top five results in 19 cases and within the top ten in all 20.
+
+## Installation
+
+The package separates querying from conversion, because they have very different
+requirements.
+
+| Command | Installs | Size |
+|---|---|---|
+| `pip install mdcx` | query and read `.mdcx` packages | ~10 MB |
+| `pip install "mdcx[mcp]"` | the above plus the MCP server | ~50 MB |
+| `pip install "mdcx[convert]"` | document conversion (Docling, PyTorch) | ~1.4 GB |
+| `pip install "mdcx[all]"` | everything, including OCR | ~1.5 GB |
+
+Conversion is what pulls in the heavy dependencies. Someone who receives an
+`.mdcx` file and only needs to query it installs neither Docling nor PyTorch.
+
+## Converting a collection
+
+```
+pip install "mdcx[convert]"
+mdcx-convert --input ./Documents --output ./Documents_md
+```
+
+The output mirrors the input directory structure, adds a global index, and
+records for each file the coverage achieved against its original.
+
+## Packaging and querying
+
+```
+mdcx pack --output ./Documents_md --target corpus.mdcx --key "..."
+mdcx info corpus.mdcx
+mdcx search corpus.mdcx "where is the minimum diameter stated" --key "..."
+mdcx export corpus.mdcx --target ./restored --key "..."
+```
+
+`info` reads the header without the key, so the issuer and the integrity of a
+file can be checked before opening it. `export` rebuilds the original folder: a
+format that cannot be left is a trap, however well intended.
+
+## Using it as an MCP server
+
+The server requires Python and this package. It does not require the conversion
+stack, so the footprint is about 50 MB.
+
+```json
+{
+  "mcpServers": {
+    "mdcx": {
+      "command": "python",
+      "args": ["-m", "mdcx.mcp_server"],
+      "env": {
+        "MDCX_FILE": "/path/to/corpus.mdcx",
+        "MDCX_KEY": "package-key"
+      }
+    }
+  }
+}
+```
+
+Alternatively, with [uv](https://docs.astral.sh/uv/) the server runs without a
+prior installation, which is the usual arrangement for Python MCP servers:
+
+```json
+{
+  "mcpServers": {
+    "mdcx": {
+      "command": "uvx",
+      "args": ["--from", "mdcx[mcp]", "python", "-m", "mdcx.mcp_server"],
+      "env": {
+        "MDCX_FILE": "/path/to/corpus.mdcx",
+        "MDCX_KEY": "package-key"
+      }
+    }
+  }
+}
+```
+
+Three tools are exposed. `search` returns the passages answering a question, each
+with its source document and portable path. `info` describes the corpus and the
+fidelity of its conversion. `document` returns a full document when passages are
+not enough.
+
+The server verifies the package before it starts listening, so a wrong path or
+key is reported immediately rather than on the first query.
+
+## Tests
+
+```
+pip install pytest
+python -m pytest tests/ -v
+```
+
+The suite covers hostile inputs: empty and corrupted files, names in other
+alphabets, malformed queries including SQL injection attempts, truncated and
+tampered packages, and compaction against content loss.
+
+## Paths
+
+No output contains absolute paths. Every document is identified by a pseudopath
+beginning with `@/`, resolved against the folder or package containing it, so a
+corpus remains valid wherever it is stored: local disk, network share or cloud.
+
+## Signing
+
+A package can be signed so that its issuer can be proven rather than merely
+declared. The signature covers the digest of the encrypted body, so it attests
+both origin and content, and is verified without the encryption key.
+
+```
+mdcx keygen
+mdcx pack --output ./Documents_md --target corpus.mdcx --key "..." \
+          --issuer "Acme Ltd" --signing-key <private-key>
+mdcx verify corpus.mdcx --public-key <public-key>
+```
+
+
+Verification also requires the body to be intact: a signature covering only the
+recorded digest would otherwise accept a package whose contents had been replaced
+while its header was left untouched.
+
+The issuer field alone is free text and proves nothing. Only a signature does.
+
+## Encryption
+
+The package encrypts at rest and decrypts in memory when opened; nothing is
+written to disk in clear. This protects a file in transit. It is not the same as
+searching over encrypted data without ever decrypting it, which is a separate
+field with documented leakage attacks and per-query costs measured in seconds.
+
+The key is derived with scrypt, which makes guessing slow: about 8 attempts per
+second, each requiring 32 MB of memory, which prevents parallelisation on a GPU.
+Even so, **the real strength is the passphrase**: a dictionary password falls in
+a day.
+
+## Authorship
+
+Conceived and directed by **Jorge Ellena G.**, programmed with the assistance of
+Claude (Anthropic).
+
+Every decision in this package was made against measurements rather than
+convention: which conversion engine to use, which licence permits which, how to
+rank a search, which optimisations to accept and which to discard. Several were
+discarded precisely because they were measured — reducing the search candidate
+pool appeared to be ten times faster and in fact lowered accuracy from 19 to 17
+out of 20 — and those measurements are recorded alongside the decisions they
+justify.
+
+## Licence
+
+Apache 2.0. The software may be used, modified and sold, provided the copyright
+notice is retained.
+
+PyMuPDF was deliberately avoided: its AGPL licence would require anyone using
+this software to publish their own under AGPL, including those offering it only
+as a network service.