Skip to main content

mdcx

PyPI License DOI

Convert a document collection to verified Markdown, package it into a single encrypted file, and query it from an agent through the Model Context Protocol.

Contents

Overview

An agent answering questions about a document collection can either receive the documents in its context window, which is bounded by the size of that window, or query a component that holds an index of them.

The following measurement covers one query — where the minimum pipe diameter to be modelled in 3D is stated — over a collection of 99 documents and 180 MB, using the cl100k_base tokenizer.

Method Model tokens Local tokens
Reading the originals 2,265,488 2,265,327
Querying the package 435 2,688,861

The 435 model tokens comprise 20 for the question, 274 for the retrieved passage and 141 for the answer.

Reading the originals costs the whole collection because a PDF is a binary format: without prior conversion there is no way to determine which of the 99 documents holds the answer, so all of them are extracted and read.

This is a single measurement rather than an average, and the saving depends on how much text an answer requires. The work is not eliminated; it moves from the context window, which is billed and finite, to local processing, which is neither. The local column rises for that reason.

The package operates in three stages.

Conversion. Each document is converted to Markdown and checked against the text the original exposes, read with a library independent from the engine that performed the conversion. Content omitted by the structured engine 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 reached 100% and none fell below 99.5%. The remaining four are scanned drawings containing no text in the file; they were read by optical character recognition and are marked as unverifiable, since no text original exists to measure them against.

Packaging. The corpus, its search index and the provenance of every passage are written to a single .mdcx file, encrypted with AES-256-GCM, whose header can be read without the key. The development collection produced 3.9 MB from 8.8 MB of Markdown.

Retrieval. A query returns the passages that answer it together with their source. Over the 20 queries used for tuning, the expected document appears within the first five results in 19 cases and within the first ten in all 20.

Requirements

Python 3.10 or later. No other component is required to query a package. Conversion and cross-language retrieval each add dependencies, listed under Installation.

Installation

Querying and conversion are separated because their requirements differ by two orders of magnitude.

Command Provides Approximate size
pip install mdcx querying and reading .mdcx packages 10 MB
pip install "mdcx[mcp]" the above and the MCP server 50 MB
pip install "mdcx[convert]" document conversion (Docling, PyTorch) 1.4 GB
pip install "mdcx[tables]" tables a page does not draw 1.2 GB
pip install "mdcx[multilingual]" cross-language retrieval 2.5 GB
pip install "mdcx[all]" all of the above, including OCR 4 GB

Conversion accounts for the heavy dependencies. A recipient who only queries an .mdcx file installs neither Docling nor PyTorch.

The multilingual extra is required for queries that cross languages. Most of its size is the embedding model, downloaded once on first use. A single-language corpus does not require it.

The tables extra covers what a page does not draw. Tables in printed material are usually found from the rules drawn around them, which costs nothing and needs no extra; borderless ones -- a screenshot of a spreadsheet, a layout held together by alignment -- are read by a small model that reports where the rows and columns run. It reads the shape only: the words still come from the text layer of the document, so a cell cannot hold anything the page does not say. Without it those pages are read by Docling instead, which is slower but already present in the convert extra.

Quick start

pip install "mdcx[convert]"

mdcx-convert --input ./Documents --output ./Documents_md
mdcx pack --output ./Documents_md --target corpus.mdcx --key "passphrase"
mdcx search corpus.mdcx "where is the minimum diameter stated" --key "passphrase"

Conversion

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.

Supported formats

PDF, EPUB, Word, Excel, PowerPoint, HTML, Markdown, CSV and plain text.

The format of a file is determined from its first bytes rather than from its extension. Repositories are known to serve EPUB files from URLs ending in .pdf and declaring application/pdf, where only the content identifies the format correctly. Routing such a file by extension sends it to a reader that cannot open it, and the resulting failure is indistinguishable from a damaged document.

Plain text carries no signature, so its extension determines the format. A file whose content identifies no known format is skipped rather than assumed.

Packaging and querying

mdcx pack --output ./Documents_md --target corpus.mdcx --key "passphrase"
mdcx info corpus.mdcx
mdcx search corpus.mdcx "where is the minimum diameter stated" --key "passphrase"
mdcx export corpus.mdcx --target ./restored --key "passphrase"

info reads the header without the key, so the issuer and the integrity of a file can be checked before it is opened. export reconstructs the original folder, so a collection can be moved out of the format at any time.

Working incrementally

A collection that is delivered once and a collection that grows every day place different demands on the tool. The second must not pay for what it has already done.

Conversion resumes

Conversion records the digest of each source in the Markdown it produces, and skips any file whose source is unchanged and whose output is present. This is the default; --force disables it.

The unit is the chapter rather than the document, so a book split into 47 chapters and interrupted at the 40th costs the remaining 7 on the next run. Progress is written after each unit and flushed to disk, so an interrupted run leaves a record that the next one reads.

A run over a converted collection reports what it reused:

Already converted and unchanged: 8 (reused)
Elapsed         : 0.4 min

A chapter is reconverted when its verification reported findings, since a result that was not certified is not a result worth keeping.

Packaging costs what was added

Indexing meaning dominates the cost of packaging. On one measured book: 505 seconds of encoding against 4 seconds of compression and 0.2 of encryption. Encoding the whole corpus on every publication makes adding one document cost a reindex of every previous one.

A passage whose text has not changed has the same vector. --reuse reads the vectors of an existing package and encodes only what is new:

mdcx pack --output ./Documents_md --target corpus-2.mdcx --key "passphrase" \
    --multilingual --reuse corpus-1.mdcx
  meaning indexed with BAAI/bge-m3 (1024 dimensions)
  passages encoded 395   reused 733

Measured over the chapters of one book, where 733 of 1,128 passages were unchanged, packaging took 15.4 seconds against 37.8 without reuse.

The vectors are read from the previous package, which already holds them and is already encrypted with the same key. No intermediate store is created: a vector allows the text it represents to be approximated, so keeping vectors outside the package would undo the encryption the format provides.

Reuse requires the same model. Vectors from two models occupy different spaces, so a package encoded by another model contributes nothing rather than contributing values that cannot be compared.

Several packages as one corpus

MDCX_FILE accepts more than one package, separated by the path separator of the platform or by a comma. The server queries all of them and returns one ranked list, with each result naming the package it came from.

{
  "mcpServers": {
    "mdcx": {
      "command": "python",
      "args": ["-m", "mdcx.mcp_server"],
      "env": {
        "MDCX_FILE": "/corpora/2026-01.mdcx:/corpora/2026-02.mdcx",
        "MDCX_KEY": "package-key"
      }
    }
  }
}

One key serves every package; several keys are matched to the packages in order.

This makes each package immutable: it is indexed once and never rebuilt. A corpus grows by adding packages rather than by enlarging one, which also keeps each of them within what can be decrypted into memory, since a package is decrypted whole when it is opened.

Results from different packages are merged by reciprocal rank. Their scores are computed over different corpus statistics — the frequency of a term depends on the corpus it is measured in — so the scores are not comparable between packages, while positions within each are.

MCP server

The server requires Python and this package. It does not require the conversion stack; its footprint is approximately 50 MB.

{
  "mcpServers": {
    "mdcx": {
      "command": "python",
      "args": ["-m", "mdcx.mcp_server"],
      "env": {
        "MDCX_FILE": "/path/to/corpus.mdcx",
        "MDCX_KEY": "package-key"
      }
    }
  }
}

With uv the server runs without prior installation, which is the common arrangement for Python MCP servers:

{
  "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:

Tool Returns
search passages answering a question, each with its source document and portable path
info the corpus record, including the fidelity of its conversion
document a complete document, when passages are insufficient

The package is verified before the server begins listening, so an incorrect path or key is reported at startup rather than on the first query.

Language support

Retrieval by word is script-aware. A query matches the words present in the documents, in any writing system, and the results of a single search may include documents in several languages. The predominant language of a corpus is recorded and reported by info; it describes the corpus and does not restrict what a query returns.

The following are verified by tests/test_languages.py, which builds one corpus holding the same four subjects — algebra, botany, printing and baking — in every language listed, then issues a query in each. Each query competes against the three other documents in its own language and against the remainder of the corpus. All 136 queries return the expected document in first position.

Script Languages
Latin English, Spanish, Portuguese, French, Italian, German, Dutch, Swedish, Danish, Norwegian, Finnish, Polish, Czech, Hungarian, Romanian, Turkish, Indonesian, Vietnamese, Catalan
Cyrillic Russian, Ukrainian, Bulgarian, Serbian
Greek Greek
Arabic Arabic, Persian
Hebrew Hebrew
Devanagari Hindi
Bengali Bengali
Tamil Tamil
Thai Thai
Han Chinese, Japanese
Hangul Korean

Support is a property of the writing system rather than of the language, so a language written in any of these scripts is covered whether or not it is listed. Three properties establish this:

Tokenisation. A word is a run of letters, digits and the combining marks attached to them. The set of combining marks is derived from the Unicode character database rather than enumerated, which keeps the vowel signs of Devanagari, Bengali, Tamil and Thai attached to the letters they modify.

Accent folding. Folding is restricted to combining marks that represent an accent placed on a letter, so that café matches cafe. The vowel signs of Indic scripts and the points of Hebrew and Arabic are preserved, since in those scripts they carry the sound of the syllable.

Segmentation. Writing systems that do not separate words with spaces — Chinese, Japanese, Korean, Thai, Lao, Khmer, Burmese, Tibetan and Javanese — are indexed by character, at index time and query time alike. This is what a lexical index can match without a segmenter trained on a single language.

Word matching operates within a language: the words of a query must be present in the document. A query written in one language reaches a document written in another only where the two share a term, as proper names and loanwords often do. When a query returns no result and none of its terms appear in the index, the response states this and names the language of the corpus, distinguishing an empty answer from material the corpus does not hold.

Retrieval across languages is a separate capability, described below. It is optional, requires a model, and is merged with word matching rather than replacing it.

Cross-language retrieval

Word matching operates within a language. A Spanish query and a German document on the same subject share no term, so a word index has nothing to match. Measured on a corpus written in 34 languages, a query retrieves 4.2% of the documents on its subject, comprising essentially those written in the language of the query.

Retrieving the remainder requires representing meaning rather than spelling. A multilingual embedding model places a sentence and its translation at nearby points in a vector space, so a document can be retrieved through its content rather than its vocabulary. When built with --multilingual, a package stores a vector for each passage alongside the passage, under the same encryption, and the same query retrieves 96.9% of the documents.

pip install "mdcx[multilingual]"
mdcx pack --output ./Documents_md --target corpus.mdcx \
    --key "passphrase" --multilingual

The corpus is encoded once, when the package is built. A recipient encodes only their own queries.

Merged engines

Both engines are retained because their failure modes are complementary. Measured on the same corpus of 136 documents in 34 languages:

Engine Across languages Expected document ranked first
Word 4.2% 136 of 136
Meaning 98.5% 126 of 136
Merged 96.9% 135 of 136

The dense engine retrieves across languages but ranks less precisely within the language of the query. The lexical engine ranks precisely and does not retrieve beyond that language. Merging by reciprocal rank retains both properties, at a cost of one document in 136 relative to the lexical engine alone.

Ranks are merged rather than scores, as a BM25 score and a cosine similarity have no common scale.

--mode lexical and --mode semantic select a single engine.

Model selection

The default is BAAI/bge-m3. Models were compared on FLORES-200, a corpus of sentences translated by professionals into 200 languages. The task is to retrieve a sentence given its translation, among candidates drawn from the same corpus, in both directions of every language pair.

The selection criterion is the worst-performing language pair rather than the mean, since a mean can conceal a language on which a model performs poorly.

Model Mean Worst language Worst pair
BAAI/bge-m3 100.0% 99.8% 98.0%
sentence-transformers/LaBSE 99.5% 97.7% 96.0%
intfloat/multilingual-e5-large 98.9% 96.5% 92.0%
intfloat/multilingual-e5-small 97.0% 94.4% 92.0%
ibm-granite/granite-embedding-97m-multilingual-r2 95.4% 91.3% 84.0%

Measured over 132 language directions covering 10 writing systems, with 50 candidates per query. In a larger run of 1,122 directions across all 34 languages with 100 candidates, LaBSE reached a mean of 99.6% and 93.5% on its worst language, with no pair below 90%.

An alternative model is selected by name:

MDCX_MODEL=sentence-transformers/LaBSE mdcx pack ...

A package records the model that encoded it. A query encoded with a different model occupies a different vector space, so a mismatch disables meaning-based retrieval rather than returning results that cannot be compared.

Portable paths

No output contains absolute paths. Each document is identified by a pseudopath beginning with @/, resolved against the folder or package containing it, so a corpus remains valid on local disk, network share or cloud storage.

Signing

A package can be signed so that its issuer can be verified rather than declared. The signature covers the digest of the encrypted body, attesting to both origin and content, and is verified without the encryption key.

mdcx keygen
mdcx pack --output ./Documents_md --target corpus.mdcx --key "passphrase" \
          --issuer "Acme Ltd" --signing-key <private-key>
mdcx verify corpus.mdcx --public-key <public-key>

Verification requires the body to be intact. A signature covering only the recorded digest would accept a package whose contents had been replaced while its header was left unmodified.

The issuer field is free text and is not evidence of origin on its own.

Encryption

Packages are encrypted at rest and decrypted in memory when opened; no plaintext is written to disk. This protects a file in transit and at rest. It is not equivalent to searching over encrypted data without decryption, which is a distinct field with documented leakage attacks and per-query costs measured in seconds.

The key is derived with scrypt at approximately 8 attempts per second, each requiring 32 MB of memory, which prevents parallelisation on a GPU. The strength of the encryption depends on the passphrase; a dictionary passphrase is recoverable within a day.

Limitations

Retrieval returns documents whose content is close to the query. It does not translate them: passages are returned in the language in which they were written.

Documents that expose no text, such as scanned drawings, are read by optical character recognition and counted as unverifiable rather than as findings, since no text original exists against which to measure fidelity. Coverage is computed over the documents that could be measured, so an unverifiable document neither raises nor lowers it.

Coverage measures the tokens preserved by a conversion. It does not measure the preservation of table structure, which is reported separately.

A package is decrypted in full when it is opened, so its size is bounded by the memory available. A corpus larger than that is held as several packages and queried together, as described under Working incrementally.

Tests

pip install pytest
python -m pytest tests/ -v

120 tests in eight groups.

File Scope
test_stress.py hostile inputs: empty and corrupted files, names in other alphabets, malformed queries including SQL injection, truncated and tampered packages, concurrent access, and compaction against content loss
test_languages.py retrieval in 34 languages across 11 writing systems, and the requirement that a term shared by several languages returns the documents of all of them
test_formats.py identification of a file by content rather than extension, in both directions, and the extraction of reference text from EPUB
test_multilingual.py retrieval across languages, and the requirement that merging engines preserves the precision of the lexical engine
test_incremental.py reuse of vectors between packages: that unchanged passages are not encoded again, that an edited one is, and that reuse produces the same ranking
test_multipackage.py querying several packages as one corpus, including key configuration and the reporting of a missing package
test_reporting.py that the summary separates a document measured and found short from one that could not be measured at all
test_console.py that a document name the console cannot represent does not stop the conversion, in the parent process and in the workers

test_multilingual.py is skipped when the multilingual extra is not installed, which is a supported configuration.

Contributing

Issues and pull requests are accepted at github.com/jorgell23-sys/mdcx.

A change to retrieval or conversion should be accompanied by the measurement that justifies it, run against the test corpora in tests/data/. A pull request is expected to leave the existing test suite passing.

Security

To report a vulnerability, open a security advisory at github.com/jorgell23-sys/mdcx/security/advisories rather than a public issue.

Packages are encrypted with AES-256-GCM and keys derived with scrypt. The encryption protects a package at rest and in transit; it does not protect against a compromised host, where the key is present in memory while the package is open.

Releases

Version history and release notes: github.com/jorgell23-sys/mdcx/releases.

Versioning follows Semantic Versioning. The .mdcx format is read backwards-compatibly: a package written by an earlier version remains readable by a later one.

Authorship

Conceived and directed by Jorge Ellena G., implemented with the assistance of Claude (Anthropic).

Design decisions in this package are recorded alongside the measurements that justify them, including those that were rejected. Reducing the candidate pool during retrieval, for example, was measured as approximately ten times faster and was rejected because it lowered accuracy from 19 to 17 of 20 queries.

Citation

Archived on Zenodo with a permanent identifier. The concept DOI resolves to the latest version:

https://doi.org/10.5281/zenodo.22015991

Licence

Apache 2.0. See LICENSE. Third-party components and their licences are listed in NOTICE.

PyMuPDF is not used. Its AGPL licence would require software incorporating this package to be published under AGPL, including software offered as a network service.

Download files

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

Source Distribution

mdcx-1.5.1.tar.gz (128.9 kB view details)

Uploaded Source

Built Distribution

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

mdcx-1.5.1-py3-none-any.whl (103.8 kB view details)

Uploaded Python 3

File details

Details for the file mdcx-1.5.1.tar.gz.

File metadata

  • Download URL: mdcx-1.5.1.tar.gz
  • Upload date:
  • Size: 128.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.10

File hashes

Hashes for mdcx-1.5.1.tar.gz
Algorithm Hash digest
SHA256 4f3bf1785179549d7865bd7fec85c3a1d2df40e76b11d30bba52eebcd12778da
MD5 c26d211a8689c76b84eb53bc60feeea6
BLAKE2b-256 111dbd00b0f30d48e8abbde8cb1bbc48f76beedca1568ddfdfa021e46c6710d2

See more details on using hashes here.

File details

Details for the file mdcx-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: mdcx-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 103.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.10

File hashes

Hashes for mdcx-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 73f4ea5e996af04917bc0c178efceb5d630d50b3a02bc132e0c71a0c713d9916
MD5 0cf15c2d2556def0d6e499f1d5634ac8
BLAKE2b-256 0259f6802392d8b3c31d24906b93c394dbf1fe52e8313e51cc9adf6aa59c7655

See more details on using hashes here.

Release history Release notifications | RSS feed

1.22.0

2 files

1.21.1

2 files

1.21.0

2 files

1.20.0

2 files

1.19.0

2 files

1.18.0

2 files

1.17.0

2 files

1.16.0

2 files

1.15.1

2 files

1.15.0

2 files

1.14.0

2 files

1.13.0

2 files

1.12.0

2 files

1.11.0

2 files

1.10.0

2 files

1.9.0

2 files

1.8.0

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

1.6.9

2 files

1.6.8

2 files

1.6.7

2 files

1.6.6

2 files

1.6.5

2 files

1.6.4

2 files

1.6.3

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

This release

1.5.1 This release

2 files

1.5.0

2 files

1.4.0

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page