CompactPrompt

io.github.gtkcyber由 GitHub 帳號 gtkcyber 發布v0.5.2更新於 Nov 3, 2026

Review and compact prompts, docs, and AI-agent skills to save tokens, preserving structure.

已驗證STDIO僅桌面開發者工具AI 與機器學習

概覽

AI 產生的概覽

CompactPrompt 的 MCP 伺服器讓助理檢視並壓縮提示詞、文件與 AI 代理技能檔案,在保留結構的同時減少 token 用量。

可以做什麼
  • 檢視提示詞、Markdown 文件與技能檔案,回報可節省 token 的地方
  • 壓縮提示詞與文字,刪除低價值措辭,可依比例或目標 token 數控制
  • 以佔位符字典可逆地縮短重複片語,並可還原原文
  • 降低數值表格精度並提供保證的最大誤差,或從候選中挑選具代表性的範例
  • 壓縮整個 Markdown 檔案與技能檔案,保留 frontmatter、程式碼區塊、標題與連結
適用情境
當提示詞、文件或 Claude Code 技能檔案過長、成本偏高或接近模型輸入上限,且希望由助理在不破壞結構的前提下評估並縮減時適用。
執行需求
以本機 stdio 程序執行,需用 pip 從 PyPI 安裝含 mcp 附加項的套件,提供 compactprompt-mcp 指令,需要 Python 環境。內建引擎無需額外設定;llmlingua 引擎需下載模型,caveman 引擎需能存取語言模型。
安裝前請注意
措辭裁剪是有損的,刪除的字詞無法復原,請保留原文。檔案壓縮僅在加上 --apply 時寫入,且會先儲存 .bak 備份;看起來像程式碼、設定或密鑰的檔案會被跳過。caveman 引擎會把文字送往語言模型,llmlingua 引擎會下載模型。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 CompactPrompt,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

CompactPrompt

[Tests] [Pylint] [Documentation Status] [PyPI - Version] [gtkcyber/compact_prompt MCP server] [CompactPrompt MCP on mcprush]

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.

Background

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.

Getting started

Install the library:

bash
pip install compactprompt

Shorten a prompt:

python
from compactprompt import CompactPrompt
result = CompactPrompt.compact(    "Please could you very kindly go ahead and provide a really concise "    "summary of the quarterly report.")
print(result.text)print(f"{result.ratio:.1f}x smaller "      f"({result.tokens_before} -> {result.tokens_after} tokens)")

Output:

a really concise summary of the quarterly report.1.7x smaller (22 -> 13 tokens)

The filler — "Please could you very kindly go ahead and" — is removed, and the meaning is unchanged.

What it does

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.

Trimming low-value wording

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.

python
from compactprompt import CompactPrompt
# Remove approximately 40% of the tokensresult = CompactPrompt.compact(prompt, ratio=0.4)
# Or target a specific sizeresult = CompactPrompt.compact(prompt, budget=64)
Technical detail

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.

Reversible shortening of repeated phrases

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.

python
import compactprompt as cp
doc = "operating cash flow rose. operating cash flow fell. operating cash flow held."abbr = cp.abbreviate(doc, n=3)
print(abbr.text)        # '@0 rose. @0 fell. @0 held.'print(abbr.dictionary)  # {'@0': 'operating cash flow'}print(abbr.restore())   # the exact original

Retain abbr.dictionary so the placeholders can be expanded again later.

Reducing the size of numeric data

Large tables of numbers consume many tokens. This lowers their precision to save space while guaranteeing that the rounding never exceeds a known bound.

python
import compactprompt as cp
q = cp.quantize([1.0, 2.5, 3.3, 4.8, 9.2, 10.0], bits=8)q.reconstruct()   # the rounded valuesq.max_error       # the guaranteed maximum error

Selecting representative examples

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.

python
from compactprompt import select_examples
chosen = select_examples(my_examples)chosen.examples

Choosing how the wording is trimmed

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.

EngineApproachRequirements
Built-in (default)Scores each word and removes the least useful. Runs locally.None
LLMLinguaMicrosoft's established tool, which uses a small model to decide what to remove.Downloads a model
CavemanRewrites the text in a concise style, preserving code, links, and headings.Access to a language model
python
CompactPrompt.compact(prompt)                       # built-in, no extra installCompactPrompt.compact(prompt, engine="llmlingua")   # pip install 'compactprompt[llmlingua]'CompactPrompt.compact(prompt, engine="caveman")     # pip install 'compactprompt[caveman]'

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.

Compacting files and skills

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:

bash
# See where the savings are (read-only)compactprompt review ./skills
# Preview the compaction of one skill (writes nothing)compactprompt compact ./skills/my-skill/SKILL.md --engine builtin
# Apply it (saves SKILL.md.bak, then rewrites the file)compactprompt compact ./skills/my-skill/SKILL.md --engine caveman --apply

--engine is required — you choose builtin, llmlingua, or caveman each time (caveman, which rewrites prose, is usually best for human-readable files).

From Python:

python
from compactprompt import review_file, compact_file
report = review_file("SKILL.md")print(report.tokens, report.issues)
result = compact_file("SKILL.md", engine="caveman", apply=True)print(result.tokens_before, "->", result.tokens_after)

The Streamlit app's Files & Skills tab does the same interactively.

Optional features

The basic installation requires no setup. Additional features depend on extra components, which you install only as needed:

bash
pip install compactprompt                  # core: trimming and reversible shorteningpip install 'compactprompt[ml]'            # numeric reduction and example selectionpip install 'compactprompt[llmlingua]'     # the LLMLingua enginepip install 'compactprompt[caveman]'       # the Caveman enginepip install 'compactprompt[mcp]'           # the MCP server for AI agentspip install 'compactprompt[app]'           # the interactive applicationpip install 'compactprompt[all]'           # everything

When a feature needs a component that is not installed, CompactPrompt reports exactly what to install.

Interactive application

A small web application lets you paste a prompt and see it shortened, with the savings reported as you go:

bash
pip install 'compactprompt[app]'streamlit run compactprompt_app.py

It opens in the browser. Use the sidebar to choose an engine and set how much to remove.

Use it from an AI agent

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:

bash
pip install 'compactprompt[mcp]'      # provides the `compactprompt-mcp` commandclaude mcp add compactprompt -- compactprompt-mcp   # e.g. for Claude Code

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.

Confirming the meaning is preserved

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:

python
from compactprompt import cosine_fidelity   # pip install 'compactprompt[embeddings]'
score = cosine_fidelity(original_text, result.text)print(score.mean)

Reference

CompactPrompt.compact(...) returns a result object with the following fields:

FieldMeaning
.textThe shortened prompt.
.originalThe input.
.tokens_before / .tokens_afterSize before and after.
.ratioHow many times smaller (for example, 2.3).
.savingsFraction of tokens saved (for example, 0.4).
.dictionaryThe key for restoring shortened phrases, when used.
.restore()Reverses the reversible shortening step.

The principal options:

python
CompactPrompt.compact(    prompt,    ratio=0.5,          # how much to remove: 0.5 targets about half the tokens    budget=None,        # alternatively, a specific target token count    prune=True,         # trim the wording (default)    abbreviate=False,   # also shorten repeated phrases (reversible)    engine="builtin",   # "builtin", "llmlingua", or "caveman")

The complete reference, including the advanced options, is in the documentation.

Development

Run the tests:

bash
pip install pytestpytest

The suite runs against the dependency-free core; tests for optional features are skipped automatically when those components are absent.

Build the documentation locally:

bash
pip install 'compactprompt[docs]'mkdocs serve

Citation

This library implements the methodology from:

bibtex
@article{choi2025compactprompt,  title={CompactPrompt: A Unified Pipeline for Prompt and Data Compression in LLM Workflows},  author={Choi, Joong Ho and Zhao, Jiayang and Shah, Jeel and Sonawane, Ritvika and          Singh, Vedant and Appalla, Avani and Flanagan, Will and Condessa, Filipe},  journal={arXiv preprint arXiv:2510.18043},  year={2025}}

It is an independent implementation and is not affiliated with the authors of the paper.

Attribution

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.

來源:README.md,提交 53140c4

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包,因此其工具未知。

版本歷史

1
  1. v0.5.2最新Sep 16, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分