Skip to main content

Token-compression toolkit for LLM payloads (Python binding over the tokenfold-core Rust crate)

Project description

TOKENFOLD

Send less noise. Fit more context. Pay for fewer input tokens.

Local, provider-neutral compression for prompts, tool schemas, JSON, logs, and diffs.

CI Coverage GitHub Release PyPI npm Rust License

Quick start · Why tokenfold · Integrations · Benchmarks


Proven compression, not projections

Repetitive JSON API responses Tool schemas
67.6% fewer tokens 61.3% fewer tokens 45.63% fewer tokens
50-record payload 30-record payload 1.8 MB OpenAI-style fixture

All three results use exact o200k_base counts in balanced mode. The JSON-data results are lossless. The schema benchmark preserves required fields and descriptions while trimming redundant examples. Repetitive, structured data benefits most.

Quick start

Install the interface that fits your stack:

pip install tokenfold       # Python 3.9+
npm install tokenfold       # Node.js 22+
cargo add tokenfold-core    # Rust library
cargo install tokenfold-cli # Rust CLI

Or download the CLI for Linux, macOS, or Windows from GitHub Releases, then verify it with the adjacent .sha256 file.

Or install the Python package:

pip install tokenfold

Compress an OpenAI-style request before sending it to your provider:

import json
from pathlib import Path

from tokenfold import CompressionMode, compress_openai_payload

result = compress_openai_payload(
    Path("request.json").read_text(),
    mode=CompressionMode.BALANCED,
)
compressed_request = json.loads(result.payload)

print(f"saved {result.report.saved_tokens} tokens ({result.saved_pct():.1f}%)")
# Pass compressed_request to your existing OpenAI client.

The TypeScript package calls the same local Rust engine and returns bytes plus the canonical compression receipt:

import { compress } from "tokenfold";

const input = new TextEncoder().encode(JSON.stringify({
  results: [
    { id: 101, region: "us-east-1", plan: "pro" },
    { id: 102, region: "us-east-1", plan: "pro" },
    { id: 103, region: "us-east-1", plan: "pro" },
  ],
}, null, 2));

const { payload, report } = await compress(input, {
  format: "json",
  mode: "balanced",
});

console.log(`saved ${report.saved_tokens} tokens`);
console.log(new TextDecoder().decode(payload));

Want to try the CLI from source? Inspect the bundled request without changing it:

git clone https://github.com/snchimata/tokenfold.git
cd tokenfold
cargo run --release --locked -p tokenfold-cli -- \
  inspect examples/openai_payload.json --format openai

Across 100 requests with the same payload shape, those savings add up to:

json_minify          34,600 → 22,900   saved 11,700
schema_compaction    22,900 → 21,300   saved  1,600
TOTAL                34,600 → 21,300   saved 13,300 (38.4% reduction, estimated)

Why tokenfold

Models do not need the same object key hundreds of times. Providers still count every token. Tokenfold removes that structural waste before the model call, so you get:

  • Lower input cost — send fewer billable tokens without changing providers.
  • More useful context — reclaim room for instructions, evidence, and conversation history.
  • Less data movement — shrink payloads crossing queues, proxies, logs, and evaluation runs.
  • Fewer blind spots — inspect counts, transforms, and warnings.
  • No new data processor — run locally, in-process, or behind your own loopback proxy.
messages · schemas · JSON · logs · diffs
                    │
                    ▼
                tokenfold ──────▶ any LLM provider
                    │
                    └───────────▶ compressed payload + receipt

What it improves

Workload User benefit
APIs and record sets Store repeated keys and values once
Provider requests Shrink messages and schemas without changing API shape
Agent logs and diffs Keep evidence; collapse repetitive output
Token budgets Meet the target or return an honest best effort
Sensitive workflows Redact detected secrets before reports or storage

Pick your integration

One Rust engine powers every surface, so policies and receipts stay consistent as your stack changes.

Surface Best for Install or run
Python Applications and evaluation pipelines pip install tokenfold
TypeScript Node.js applications and automation npm install tokenfold
Rust Native embedding cargo add tokenfold-core
CLI Files and command output Download a release binary
HTTP proxy Provider-shaped traffic Build tokenfold-proxy from source
MCP server MCP-compatible agents and editors tokenfold mcp serve

Compress generic JSON

Use format="JSON" for API responses, record dumps, and other data that is not an LLM request:

import json
import tokenfold

result = tokenfold.compress(
    json.dumps({
        "results": [
            {"id": 101, "region": "us-east-1", "plan": "pro"},
            {"id": 102, "region": "us-east-1", "plan": "pro"},
            {"id": 103, "region": "us-east-1", "plan": "pro"},
        ]
    }),
    format="JSON",
    mode="BALANCED",
)

print(f"saved {result.report.saved_tokens} tokens")

Run the proxy

cargo build --release --locked -p tokenfold-proxy
target/release/tokenfold-proxy \
  --upstream https://api.openai.com \
  --target-tokens 12000

The proxy listens on 127.0.0.1:8787 by default, streams SSE responses, and returns the compression receipt in X-TokenFold-* headers.

Safety you can inspect

Tokenfold recounts after every stage and stops when the target is met or the allowed transform set is exhausted.

  • Never larger: a transform stays only when it reduces the token count.
  • Reversible JSON: every structural rewrite must pass an exact round trip.
  • Clear provenance: exact tokenizer results and estimates are labeled separately.
  • Actionable receipts: every result lists savings, transforms, warnings, and final status.
  • Honest limits: unreachable targets return an explicit status instead of silently deleting more content.

Lossy log and diff transforms remain policy-gated. Optional originals can be stored by SHA-256 hash; detected secret-shaped content is excluded.

Reproduce the numbers

Fixture Exact token reduction Source
Repetitive 50-record JSON 67.6% Changelog
30-record API response 61.3% Changelog
1.8 MB OpenAI tool schema 45.63% Thresholds

Run the regression benchmark:

cargo bench -p tokenfold-core

Or inspect the small bundled JSON sample:

cargo run --release --locked -p tokenfold-cli -- \
  inspect examples/api_response.json --format json

The sample reports 382 → 206 estimated tokens, a 46.1% reduction. Ragged or compact inputs may save little; Tokenfold reports that result honestly.

Contributing

Issues and pull requests are welcome. Run the core checks before opening a PR:

cargo fmt --all --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace --locked
python eval/run_fidelity.py --gate --profile smoke-first-consumer
cd packages/tokenfold && npm ci && npm test

License

Apache-2.0

Reclaim your context window

Start with one representative payload. Install tokenfold, inspect the receipt, and see how many tokens your application can stop sending today.

pip install tokenfold

Project details


Download files

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

Source Distribution

tokenfold-0.3.3.tar.gz (107.0 kB view details)

Uploaded Source

Built Distributions

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

tokenfold-0.3.3-cp39-abi3-win_amd64.whl (2.9 MB view details)

Uploaded CPython 3.9+Windows x86-64

tokenfold-0.3.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.2 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

tokenfold-0.3.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (3.1 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

tokenfold-0.3.3-cp39-abi3-macosx_11_0_arm64.whl (3.0 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

tokenfold-0.3.3-cp39-abi3-macosx_10_12_x86_64.whl (3.0 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

Details for the file tokenfold-0.3.3.tar.gz.

File metadata

  • Download URL: tokenfold-0.3.3.tar.gz
  • Upload date:
  • Size: 107.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for tokenfold-0.3.3.tar.gz
Algorithm Hash digest
SHA256 7fcc624fa938b729c82f0a59fc49b2e76cd4a27d718736b73657ec4afec69493
MD5 24c612e3246be5fe9e250add7c606a2f
BLAKE2b-256 5a0d97b538c416d8c3ecc5b3dd56efaae3d9c5eac75b2b6f4a39d60b6b2881cf

See more details on using hashes here.

File details

Details for the file tokenfold-0.3.3-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: tokenfold-0.3.3-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for tokenfold-0.3.3-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 e5bebf9d02ea39f2dd7a3d2981c2599955ffbbdb1272907a64e92365501ca0a8
MD5 04133c93e750ce19728e6b88ce89d964
BLAKE2b-256 361cfeef01d1501e6a43ec56de15a58b29da3a2eb74ea29b25257d38644ca4bc

See more details on using hashes here.

File details

Details for the file tokenfold-0.3.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tokenfold-0.3.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 289bf476ec805fc61bc0389802a0e2f4194665f4739eb53601251eac8c2d09cb
MD5 8450bcd283399e3f79bc1c6c29032b03
BLAKE2b-256 cb0bd316e1735f7e931c6bdba91b9e3e1199f82749f2c819d2808ee33456c59a

See more details on using hashes here.

File details

Details for the file tokenfold-0.3.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for tokenfold-0.3.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 2ff4700981ce5850eda97dc3537a5b0433449e0631d75f87686311c2097cb5dc
MD5 c5a6c6973482617fe71e3bae14ea5ccf
BLAKE2b-256 f99720ab838775af0d93c2e3993474607925525a8462e4527b26489239cbe45c

See more details on using hashes here.

File details

Details for the file tokenfold-0.3.3-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tokenfold-0.3.3-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5e77506feea3ca9c3a24fd734d6026f36a7d4d5930c7a997cd26c0f673c1abfe
MD5 f2622a1837b66709593974f7bb7eb935
BLAKE2b-256 ac07e5267bcab09796c526c3d85df4f02642d4d46af6f6599ab28cd0e8e7b147

See more details on using hashes here.

File details

Details for the file tokenfold-0.3.3-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for tokenfold-0.3.3-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a61f44f9fa8ebbbf86741968f2d8cda80700de8920f89469fbd79c6d7ace2de1
MD5 45baaaefafe36ce31983b21d34df72eb
BLAKE2b-256 8879c59afbd511a341e697cbf694a5a74cc58d7f2f6a35f3ab62316cb4988b9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page