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 分