
Sugo
io.github.MuralnickPublished by GitHub account Muralnickv0.1.2Updated Nov 7, 2026
Local, offline conversion of PDFs, Office files and screenshots into compact Markdown.
Overview
Sugo converts local PDFs, Office files and screenshots into compact, cleaned Markdown for LLM and RAG use, exposing conversion and token-savings tools to…
- What you can do
- Convert documents and images: turn PDFs, DOCX, XLSX, PPTX, XML and PNG/JPEG/WEBP screenshots into Markdown, with local OCR for images
- Estimate savings: report how many tokens a conversion saves per LLM provider
- Clean and record: strip repeated headers, page numbers, hidden text and tracking parameters while logging every removal with its reason
- Produce RAG-ready output: emit Markdown or JSON Lines chunks for vector databases
- When to use it
- Useful when an agent needs to read local documents or screenshots without sending them to a cloud service, or when you want to cut token costs by feeding cleaned Markdown instead of raw extracts or images.
- Requirements
- Runs as a local process via uvx from the sugo-cli PyPI package; needs Python 3.12 to 3.14 and about 400 MB of disk for the PDF library, OCR engine and models. The MCP server is started with a root folder argument and reads only inside the folders you name. No accounts, API keys or network access are required.
Installation
In SourceWeft
- Open Sugo in the dashboard and add it to a workspace.
- Enable the server for the chats that should use its tools.
Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.
Other MCP clients
Follow the launch instructions in the repository.
README
Sugo
Documents, reduced. Feed your LLM the sauce, not the water.
[PyPI version] [CI] [Python 3.12, 3.13 and 3.14] [AGPL-3.0-or-later] [Runs 100% offline]
Quick start · What it does · Comparison · MCP · Roadmap · 🇮🇹 Italiano
Sugo turns PDFs, Office files, screenshots and images into clean, compact Markdown for RAG systems, AI agents and LLM chats. It removes what only costs tokens (repeated headers and footers, page numbers, hidden text, tracking parameters, app chrome around a screenshot) and keeps the content, the tables and the structure. Everything runs on your computer: no cloud API, no telemetry, nothing sent anywhere.
In Italian, il sugo del discorso means "the gist", and a sugo is a sauce you reduce until only the concentrated flavour remains. That is what Sugo does to your documents.
What it does
A small generated three-page PDF, as a plain text extractor gives it to your model (pages 1 and 3 look the same):
What sugo report.pdf prints:
The header is kept once instead of on every page; the page numbers, the repeated "Confidential" and the tracking parameters are gone; the text is the same. sugo stats measures the difference: 180 → 97 tokens, 46% saved on this small generated example; real documents with less page furniture save much less (see below). Every removal is recorded with the cleaner that made it and the reason, so you can always check what was dropped. Text that cannot be read is marked as illegible, never guessed.
Across a benchmark corpus in five languages, no text went missing in any document (on 3 screenshots the OCR misread a few characters, 1–7%). Savings depend heavily on the document:
And it stays fast on an ordinary computer, not just a new one: on a 2010 desktop with 2 cores and no GPU, a 100-page PDF converts in 3.6 s and a phone screenshot in 13.7 s (full numbers in TESTING).
How it compares
Measured against two well-known alternatives, on the same 31-document benchmark corpus (26 synthetic documents made by the Sugo project plus 5 real EU-regulation PDFs), with the same tokenizer and the same ground truth — full method, raw numbers and limits in docs/comparisons:
A tool that drops content also "saves" tokens on paper — that's data loss, not compression. Every number above is paired with what actually survived the conversion.
Fair caveats: the corpus is small and mostly synthetic, and it was built by the Sugo authors, so treat it as a sanity check, not a verdict. On the report PDFs Docling saves slightly more tokens than Sugo (about 38–48% vs 33–38%) without losing content; it is also several times slower on this corpus. Raw data and the full per-document table are in the linked comparison.
Status
[!NOTE] v0.1.1 is out, on PyPI as
sugo-cli(v0.1.0 was the first signed release). It is still 0.x: contracts may change, with notice, before 1.0. Releases are built reproducibly, with an SBOM, Sigstore attestations and PyPI Trusted Publishing.
See the roadmap for the full plan.
Quick start
Sugo needs Python 3.12, 3.13 or 3.14. The install is about 400 MB on disk, because the PDF library, the OCR engine and its models come with it. The easiest way to install it is with uv:
Or with pip:
If sugo is "not recognized" or "not found" after installing with pip, pip put it in a folder your system does not search. This happens on Windows when pip installs for your user only ("Defaulting to user installation"). Either install with uv tool install sugo-cli and run uv tool update-shell once, or add the folder pip names in its warning (on Windows, %APPDATA%\Python\Python3XX\Scripts) to your Path, then open a new terminal.
[!TIP] The package is called
sugo-clibecause the namesugoon PyPI is held by an unrelated, empty project (a name transfer request is open). The installed command is stillsugo;sugo-cliworks too. Older instructions withsugo-cli[lite]still work: everything is now included by default.
To run the latest development version from source instead:
Convert a file and print its Markdown:
More things you can do:
Add --json for output a script can read.
Use it from an AI agent (MCP)
Sugo can serve agents such as Claude Code or Codex over MCP. It reads only inside the folders you name:
The agent gets two tools: convert_document and estimate_savings.
Uninstall
Remove the program the same way you installed it:
Or, if you used pip:
If you added Sugo to an agent, remove it there too, for example claude mcp remove sugo.
Uninstalling the program does not delete the files Sugo created. They are only on your computer, and you can delete them by hand:
If you set SUGO_CACHE_DIR, the cache is in that folder instead. The cache holds text from the documents you converted, so delete it if those documents were private. Apart from these two folders and the files you asked it to write (such as -o output or receipts), Sugo keeps nothing else on disk.
On an old computer
Measured on 2026-11-03 on a 2010 desktop: Intel Core i5-650 (2 cores, 4 threads, no AVX), 8 GB RAM, SSD, no usable GPU. Weaker than the 8 GB, 4-core machine Sugo targets.
Native documents run well within the targets even on this machine. OCR is accurate but slow on a CPU without AVX; making it faster is on the roadmap. Details and scripts are in TESTING.
Supported files
Old .doc, .xls and .ppt files and password-protected files are not read: save a new copy first.
How it works
Each reader turns a file into the same structure of pages and blocks. Cleaners only propose changes; the core applies them and marks each removed block with who removed it and why, instead of deleting it. That is what makes the output checkable and reproducible. The full design is in ARCHITECTURE.
Promises
These are written down in PRINCIPLES and checked by tests:
- Local by principle. Conversion never needs the internet. No cloud API, no telemetry.
- No guessing. Unreadable text is marked as illegible, never filled in.
- Nothing silently lost. Every removal is recorded, with its reason.
- Honest metrics. Savings are measured, and Sugo also tells you when sending the original image would be cheaper.
- Safe with untrusted files. Size and time limits, XML parsed safely, models verified by checksum. See the threat model.
Documentation
Contributing and security
See CONTRIBUTING. Please report vulnerabilities privately, as described in SECURITY, not in public issues.
License
AGPL-3.0-or-later (see ADR-010).
Source: README.md at commit 198f727
Tools
0Version history
1- v0.1.2LatestNov 7, 2026
Score
50% of the applicable checks met
How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.
- Reached in the last 30 days25 pts
Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.
- Auth declared10 pts
Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.
- Tools listed15 pts
Answer tools/list without a credential, or ship a package that starts in a sandbox without one.
- DescriptionRequired15 pts
- Logo10 pts
- Documentation15 pts
- License10 pts