The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the CompactPrompt listing page.
CompactPrompt shortens the text you send to an AI model while preserving its meaning. The result costs less to run, returns faster, and is less likely to exceed the model's input limit. The common case is a single function call, and no background in machine learning is required to use it.
An AI model reads an input — the prompt — and returns a response. Providers charge according to the amount of text processed, measured in tokens (each token is roughly three-quarters of a word), and every model has a maximum input size. A long prompt that combines instructions, documents, tables, and examples therefore costs more, responds more slowly, and may not fit at all.
CompactPrompt reduces the size of a prompt while retaining the information that matters, so you keep the substance and discard the overhead.
Install the library:
Shorten a prompt:
Output:
The filler — "Please could you very kindly go ahead and" — is removed, and the meaning is unchanged.
CompactPrompt provides several methods for reducing the size of a prompt. They can be used individually or together. Each is described below in plain terms, followed by an optional technical note.
Removes words that carry little meaning, such as conversational filler, and keeps the words that do. This is lossy: the removed words are not recoverable, but the result is ready to use as it is.
Each word receives an information score that combines how rare it is in general (static self-information) with how predictable it is in context (dynamic self-information from a small language model). Low-scoring words are removed. Whole grammatical phrases are removed together, using spaCy, so the result remains readable, and names and numbers are protected. This implements the fusion rule from the CompactPrompt paper.
When a phrase recurs, it is replaced with a short placeholder, and a key records what each placeholder stands for. This is lossless: the exact original can be restored at any time.
Retain abbr.dictionary so the placeholders can be expanded again later.
Large tables of numbers consume many tokens. This lowers their precision to save space while guaranteeing that the rounding never exceeds a known bound.
Models perform better when shown a few examples. If you have many candidate examples, this selects a small, varied subset that still reflects the full range, so you send a representative few rather than all of them.
The wording-trimming step can be carried out by any of three interchangeable
engines. All of them shorten text; they differ in how they decide what to remove
and in what they require to run. Select one with the engine argument — nothing
else in your code changes.
| Engine | Approach | Requirements |
|---|---|---|
| Built-in (default) | Scores each word and removes the least useful. Runs locally. | None |
| LLMLingua | Microsoft's established tool, which uses a small model to decide what to remove. | Downloads a model |
| Caveman | Rewrites the text in a concise style, preserving code, links, and headings. | Access to a language model |
The built-in engine and the other core features implement the CompactPrompt research paper. LLMLingua and Caveman are independent open-source tools that this library integrates; see Attribution.
CompactPrompt can also compact whole markdown files — documentation,
CLAUDE.md, notes, and Claude Code skills (SKILL.md) — not just strings.
It can first review a file or folder to report where the savings are.
This works safely by design: YAML frontmatter is preserved exactly, fenced code
blocks and links are never altered, the result is rejected if it would change a
heading, code block, or URL, and nothing is written without --apply (which
first saves a .bak backup). Files that look like code, config, or secrets are
skipped automatically.
From the command line:
--engine is required — you choose builtin, llmlingua, or caveman each
time (caveman, which rewrites prose, is usually best for human-readable files).
From Python:
The Streamlit app's Files & Skills tab does the same interactively.
The basic installation requires no setup. Additional features depend on extra components, which you install only as needed:
When a feature needs a component that is not installed, CompactPrompt reports exactly what to install.
A small web application lets you paste a prompt and see it shortened, with the savings reported as you go:
It opens in the browser. Use the sidebar to choose an engine and set how much to remove.
CompactPrompt ships an MCP server so AI coding tools (Claude Code, Codex, Cursor, Gemini, and any MCP-capable agent) can review and compact prompts, docs, and skills directly:
The agent-skills/ directory also has lightweight skill/rules
files and an install.sh for the same tools. See its
README for per-tool configuration.
To check that a shortened prompt still means the same thing, you can measure the similarity between the original and the result, where 1.0 indicates identical meaning:
CompactPrompt.compact(...) returns a result object with the following fields:
| Field | Meaning |
|---|---|
.text | The shortened prompt. |
.original | The input. |
.tokens_before / .tokens_after | Size before and after. |
.ratio | How many times smaller (for example, 2.3). |
.savings | Fraction of tokens saved (for example, 0.4). |
.dictionary | The key for restoring shortened phrases, when used. |
.restore() | Reverses the reversible shortening step. |
The principal options:
The complete reference, including the advanced options, is in the documentation.
Run the tests:
The suite runs against the dependency-free core; tests for optional features are skipped automatically when those components are absent.
Build the documentation locally:
This library implements the methodology from:
It is an independent implementation and is not affiliated with the authors of the paper.
The Caveman engine (compactprompt/caveman.py) is adapted from
Caveman by Julius Brussee (MIT). The
LLMLingua engine uses LLMLingua by
Microsoft (MIT). Full third-party attributions and license notices are in
THIRD_PARTY_NOTICES.md.