Compress tool outputs, logs, files, and RAG chunks before they reach the LLM. 20% fewer tokens for coding agents, 60-95% fewer tokens for JSON, same answers. Library, proxy, MCP server.
Python agentaianthropicclaude-codecompressioncontext-engineeringcontext-windowcursorfastapilangchainllmmcpopenaiprompt-engineeringproxypythonragtoken-optimizationtokenstypescript
"""A buffered-CCR turn is a billed call and its usage must reach accounting.
When a ``stream:true`` request carries the ``headroom_retrieve`` tool, the
Anthropic handler buffers the whole reply (upstream streams it, the proxy folds
the stream into one Message) so it can resolve retrievals server-side, then
re-synthesizes SSE for the client. That buffered response carries the same ``usage`` block any non-stream reply does, so the
provider's cache-read / cache-write / output counts must land on the outcome.
If they don't, every cached token on the dominant Claude Code path is invisible:
``metrics.cache_by_provider`` only records a provider row when cache read or
write is non-zero, so the whole prefix-cache card (hit rate, savings, TTL mix)
is computed from whatever small fraction of traffic took another path, while
compression savings on the buffered turns still count in full.
"""
from __future__ import annotations
import json
from typing import Any
import httpx
import pytest
import respx
pytest.importorskip("fastapi")
from fastapi.testclient import TestClient # noqa: E402
from headroom.proxy.anthropic_wire import render_anthropic_sse_response # noqa: E402
from headroom.proxy.loopback_guard import require_loopback # noqa: E402
from headroom.proxy.server import ProxyConfig, create_app # noqa: E402
# Provider-reported usage for one warm turn: most of the prompt served from
# cache, a slice newly written, a little uncached, and a real completion.
_USAGE = {
"input_tokens": 300,
"output_tokens": 120,
"cache_read_input_tokens": 46893,
"cache_creation_input_tokens": 8197,
}
_RESPONSE = {
"id": "msg_buffered",
"type": "message",
"role": "assistant",
"model": "claude-opus-5",
"content": [{"type": "text", "text": "done"}],
"stop_reason": "end_turn",
"usage": _USAGE,
}
_RETRIEVE_TOOL = {
"name": "headroom_retrieve",
"description": "Retrieve compressed content",
"input_schema": {"type": "object", "properties": {"ref": {"type": "string"}}},
}
def _app_and_outcomes(monkeypatch, **overrides):
"""App with a spy on the outcome record — where billed counts land."""
kwargs: dict[str, Any] = {
"optimize": False,
"cache_enabled": False,
"rate_limit_enabled": False,
"cost_tracking_enabled": False,
"log_requests": False,
}
kwargs.update(overrides)
app = create_app(ProxyConfig(**kwargs))
app.dependency_overrides[require_loopback] = lambda: None
outcomes: list[Any] = []
async def _spy(_self, outcome, *a, **kw):
outcomes.append(outcome)
monkeypatch.setattr(type(app.state.proxy), "_record_request_outcome", _spy, raising=True)
return app, outcomes
@pytest.fixture
def ccr_marker() -> str:
"""A marker this proxy actually owns, so retrieval could really fire.
The buffered path is only taken when the outgoing body carries a redeemable
marker (#3071); ``headroom_retrieve`` has nothing to expand otherwise. The
buffered tests are about what happens *on* that path, so they have to earn it.
"""
from headroom.cache.backends import InMemoryBackend
from headroom.cache.compression_store import get_compression_store, reset_compression_store
reset_compression_store()
store = get_compression_store(backend=InMemoryBackend())
hash_key = store.store(
"the original, uncompressed tool output",
"<<ccr:placeholder>>",
original_tokens=100,
compressed_tokens=5,
tool_name="Read",
)
try:
yield hash_key
finally:
reset_compression_store()
def _post(app, *, stream: bool, tools: list[dict] | None, marker: str | None = None):
text = "hi" if marker is None else f"hi, earlier output is at <<ccr:{marker}>>"
body: dict[str, Any] = {
"model": "claude-opus-5",
"max_tokens": 256,
"messages": [{"role": "user", "content": text}],
}
if stream:
body["stream"] = True
if tools is not None:
body["tools"] = tools
with TestClient(app) as client:
return client.post("/v1/messages", json=body, headers={"x-api-key": "sk-ant-test"})
@respx.mock
def test_non_stream_turn_records_provider_usage(monkeypatch) -> None:
"""Control: the plain non-stream path already books the usage block."""
app, outcomes = _app_and_outcomes(monkeypatch)
respx.post("https://api.anthropic.com/v1/messages").mock(
return_value=httpx.Response(200, json=_RESPONSE)
)
r = _post(app, stream=False, tools=None)
assert r.status_code == 200
assert outcomes, "an outcome must be recorded"
o = outcomes[-1]
assert o.cache_read_tokens == 46893
assert o.cache_write_tokens == 8197
assert o.output_tokens == 120
@respx.mock
def test_buffered_ccr_turn_records_provider_usage(monkeypatch, ccr_marker: str) -> None:
"""A stream:true + headroom_retrieve turn must book the same usage block."""
app, outcomes = _app_and_outcomes(monkeypatch)
route = respx.post("https://api.anthropic.com/v1/messages").mock(
return_value=httpx.Response(
200,
content=b"".join(render_anthropic_sse_response(_RESPONSE)),
headers={"content-type": "text/event-stream"},
)
)
r = _post(app, stream=True, tools=[_RETRIEVE_TOOL], marker=ccr_marker)
assert r.status_code == 200
# The handler buffered it: upstream was asked for the stream it then folded.
sent = route.calls.last.request
assert json.loads(sent.content)["stream"] is True
assert outcomes, "an outcome must be recorded"
o = outcomes[-1]
assert o.cache_read_tokens == 46893, (
f"buffered-CCR turn dropped the provider cache-read count: {o.cache_read_tokens}"
)
assert o.cache_write_tokens == 8197, (
f"buffered-CCR turn dropped the provider cache-write count: {o.cache_write_tokens}"
)
assert o.output_tokens == 120, (
f"buffered-CCR turn dropped the provider output count: {o.output_tokens}"
)
@respx.mock
def test_buffered_ccr_records_usage_with_compression_on(monkeypatch, ccr_marker: str) -> None:
"""Same turn with the live token-mode pipeline running, as in production."""
app, outcomes = _app_and_outcomes(monkeypatch, optimize=True, mode="token")
respx.post("https://api.anthropic.com/v1/messages").mock(
return_value=httpx.Response(200, json=_RESPONSE)
)
r = _post(app, stream=True, tools=[_RETRIEVE_TOOL], marker=ccr_marker)
assert r.status_code == 200
assert outcomes, "an outcome must be recorded"
o = outcomes[-1]
assert (o.cache_read_tokens, o.cache_write_tokens, o.output_tokens) == (46893, 8197, 120), (
f"buffered-CCR turn dropped usage under compression: "
f"cr={o.cache_read_tokens} cw={o.cache_write_tokens} out={o.output_tokens}"
)
@respx.mock
def test_buffered_ccr_stream_gets_the_context_guard_nudge(monkeypatch, ccr_marker: str) -> None:
"""The buffered-CCR stream is resynthesized from the parsed message, so the
streaming guard never sees it. Near the wall its gauge must move anyway, or
the client gets the raised compression budget without the warning."""
import json
from headroom.proxy.context_guard import REPORT_FRACTION, reset_learned_limits
reset_learned_limits()
app, _ = _app_and_outcomes(monkeypatch)
near_wall = {**_RESPONSE, "usage": {**_USAGE, "cache_read_input_tokens": 900_000}}
respx.post("https://api.anthropic.com/v1/messages").mock(
return_value=httpx.Response(200, json=near_wall)
)
r = _post(app, stream=True, tools=[_RETRIEVE_TOOL], marker=ccr_marker)
assert r.status_code == 200
start = next(
json.loads(line[len("data:") :])
for line in r.text.splitlines()
if line.startswith("data:") and '"message_start"' in line
)
usage = start["message"]["usage"]
reported = (
usage["input_tokens"]
+ usage["cache_read_input_tokens"]
+ usage["cache_creation_input_tokens"]
)
# claude-opus-5 is a 1M model; 909k forwarded is past the trigger.
assert reported == int(1_000_000 * REPORT_FRACTION)
def _reported_input(usage: dict) -> int:
return (
usage["input_tokens"]
+ usage["cache_read_input_tokens"]
+ usage["cache_creation_input_tokens"]
)
@respx.mock
def test_non_stream_json_gets_the_context_guard_nudge(monkeypatch) -> None:
"""The plain non-stream JSON body is nudged near the wall, like the stream."""
from headroom.proxy.context_guard import REPORT_FRACTION, reset_learned_limits
reset_learned_limits()
app, _ = _app_and_outcomes(monkeypatch)
near_wall = {**_RESPONSE, "usage": {**_USAGE, "cache_read_input_tokens": 900_000}}
respx.post("https://api.anthropic.com/v1/messages").mock(
return_value=httpx.Response(200, json=near_wall)
)
r = _post(app, stream=False, tools=None)
assert r.status_code == 200
usage = r.json()["usage"]
# claude-opus-5 is a 1M model; 909k forwarded is past the trigger.
assert _reported_input(usage) == int(1_000_000 * REPORT_FRACTION)
assert usage["output_tokens"] == _USAGE["output_tokens"]
@respx.mock
def test_non_stream_json_is_untouched_with_the_guard_off(monkeypatch) -> None:
from headroom.proxy.context_guard import reset_learned_limits
reset_learned_limits()
monkeypatch.setenv("HEADROOM_CONTEXT_GUARD", "0")
app, _ = _app_and_outcomes(monkeypatch)
near_wall = {**_RESPONSE, "usage": {**_USAGE, "cache_read_input_tokens": 900_000}}
respx.post("https://api.anthropic.com/v1/messages").mock(
return_value=httpx.Response(200, json=near_wall)
)
r = _post(app, stream=False, tools=None)
assert r.status_code == 200
assert r.json()["usage"] == near_wall["usage"]
def test_buffered_nudge_follows_the_client_beta_not_the_sticky_one(monkeypatch) -> None:
"""Session-sticky merging can keep context-1m outbound after the client
dropped it. The learned cap keys on the forwarded beta; the client's gauge
is its own 200k window, so the nudge targets 95% of 200k, not of 1M."""
from headroom.proxy.context_guard import (
REPORT_FRACTION,
credential_scope,
note_prompt_too_long,
reset_learned_limits,
)
reset_learned_limits()
beta_1m = "context-1m-2025-08-07"
note_prompt_too_long(
"claude-sonnet-4-5",
beta_1m,
"prompt is too long: 213021 tokens > 200000 maximum",
scope=credential_scope("sk-sticky"),
)
app, _ = _app_and_outcomes(monkeypatch)
proxy = app.state.proxy
monkeypatch.setattr(proxy.anthropic_provider, "get_context_limit", lambda _model: 200_000)
payload = {
**_RESPONSE,
"model": "claude-sonnet-4-5",
"usage": {**_USAGE, "cache_read_input_tokens": 185_000 - 300 - 8197},
}
changed = proxy._context_guard_nudge_message(
payload,
model="claude-sonnet-4-5",
headers={"x-api-key": "sk-sticky", "anthropic-beta": beta_1m},
request_id="test-sticky-buffered",
client_beta="",
)
assert changed
assert _reported_input(payload["usage"]) == int(200_000 * REPORT_FRACTION)