deer-flow/backend/app/gateway/context_usage.py
Amorend 85c3909c2e
feat: show real-time context window usage (#3125) (#3183)
* feat: show real-time context window usage in chat UI (#3125)

Adds a `context_usage` block to `GET /api/threads/{id}/token-usage`
(token count from the live checkpoint, the thread model's
`context_window`, and a percentage), introduces a new
`ModelConfig.context_window` distinct from the per-call `max_tokens`
output cap, and surfaces the percentage in the chat header — inside
`TokenUsageIndicator` when token-usage tracking is on, or as a
standalone badge when it's off so context capacity stays visible
independent of cost tracking.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* feat: per-category breakdown for context window usage

Replace the single-number context_usage payload with a Claude-Code-style
breakdown — messages, system prompt, skills, system/MCP tools (active +
deferred), custom agents, memory injection, autocompact buffer, and free
space — and surface it in the chat UI with a segmented progress bar and
per-row table.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* docs(config): document context_window across model examples

Add `context_window` to every example model in config.example.yaml so the
new chat-UI "% context used" indicator works out of the box for whichever
example a user adopts. Each value is the published default at the time of
writing; users are pointed at the official model spec to verify. Bumps
config_version to 11 so `make config-upgrade` flags outdated user configs.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* style: ruff format (line-length 240)

No behavior change — collapses two multi-line expressions that fit on
one line under the project's 240-char limit. Picked up by `make format`.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* review: address Copilot bot comments on #3183

- token-usage-indicator: switch `{contextPercentage && (...)}` to an
  explicit `!= null` check. (The string `"0"` is actually truthy in JS so
  the original code wasn't buggy, but the explicit check is clearer.)
- context-usage-breakdown: drop the `useMemo` around segments/totals — the
  computation is O(n) over a handful of rows and the previous memo deps
  omitted `t.contextUsage.categories`, so the bar's tooltips/aria-labels
  could stay in the old language after a locale switch.
- context_usage._split_tools: snapshot MCP names from
  `get_cached_mcp_tools()` directly instead of re-reading
  `extensions_config.json` after `get_available_tools()` already loaded
  it. Removes redundant file I/O on every `/token-usage` poll.
  (`get_available_tools()` still emits its own INFO logs — silencing
  those is out of scope here.)

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* style(frontend): prettier --write context-usage-breakdown

CI's `pnpm format` (prettier --check) caught two lines previously
formatted by hand. Collapses one comma to fit on one line; no behavior
change.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* fix(gateway): correct context-usage breakdown + add exact token counting

The context-usage indicator shipped two bugs that silently zeroed whole
breakdown rows (both caught by try/except, so the feature looked alive but
produced wrong numbers):

1. _count_system_prompt passed app_config= to get_deferred_tools_prompt_section,
   which only accepts deferred_names -> TypeError swallowed -> system_prompt
   row always 0, and used_tokens/percentage undercounted by the full prompt.
   Also subtracted the deferred section twice (the rendered prompt already
   excluded it). Fix: derive deferred names deterministically and pass them to
   apply_prompt_template; drop the redundant subtraction.

2. _split_tools imported a non-existent get_deferred_registry -> ImportError
   swallowed -> all four tool-category rows always 0. Fix: classify via the
   public is_mcp_tool predicate + tool_search.enabled (mirrors
   build_deferred_tool_setup); the MCP tag is set by get_available_tools.

Added token_usage.counting (approximate|exact). 'exact' routes text/schema/
message counting through the model tokenizer (tiktoken cl100k_base) via the
existing memory-module machinery (lazy load + cache + cooldown + CJK-aware
fallback), so CJK-heavy threads stop being undercounted by chars//4.

Regression + e2e tests added; 6621 backend tests pass.

* fix(gateway): harden context usage accounting

* fix(gateway): count promoted MCP tools as active in context usage

Promoted tools (deferred MCP tools the thread has fetched via tool_search)
have their full schema bound on every subsequent turn by
DeferredToolFilterMiddleware, so they consume context like any active tool.
The breakdown previously left them in the reserved *_deferred rows, under-
counting the thread's used_tokens.

Classification now treats a tool as deferred only when tool_search is enabled,
it is MCP-sourced, AND it has not been promoted. The promoted set is read from
the checkpoint's channel_values and scoped by catalog hash — matching the
runtime middleware, so a stale promotion from MCP-config drift cannot inflate
the active count.

The static system prompt still lists all deferred tool names (promotions only
affect schema binding, not the prompt), so _count_system_prompt's deferred
rendering is intentionally left unchanged.

8 new tests cover classification, catalog-hash scoping (match / drift /
compute-failure / malformed), and checkpoint extraction.

* fix(context): address review feedback

* fix(context): count structured message payloads

* fix(context): harden usage accounting

* fix(config): bump schema for context usage fields

* refactor: narrow context usage to core indicator

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
2026-07-31 21:57:22 +08:00

87 lines
3.4 KiB
Python

"""Compute the current message-context usage for a thread."""
from __future__ import annotations
import asyncio
import logging
from typing import Any
from fastapi import HTTPException, Request
from app.gateway.deps import get_config
from app.gateway.services import build_thread_checkpoint_state_accessor
logger = logging.getLogger(__name__)
def _count_messages_approximately(messages: list[Any]) -> int:
"""Count checkpoint messages with LangChain's network-free heuristic."""
if not messages:
return 0
from langchain_core.messages.utils import count_tokens_approximately
return int(count_tokens_approximately(messages))
async def _load_checkpoint_messages(accessor: Any, config: dict[str, Any]) -> list[Any]:
"""Read materialized messages so full and delta checkpoints behave alike."""
snapshot = await accessor.aget(config)
values = getattr(snapshot, "values", None) or {}
if not isinstance(values, dict):
return []
return list(values.get("messages") or [])
async def _resolve_thread_model_name(run_store: Any, thread_id: str, app_config: Any) -> str | None:
"""Prefer the latest run's model, then fall back to the first configured model."""
try:
runs = await run_store.list_by_thread(thread_id, limit=1)
except Exception:
runs = []
if runs:
latest = runs[0]
name = latest.get("model_name") if isinstance(latest, dict) else getattr(latest, "model_name", None)
if isinstance(name, str) and name:
return name
models = getattr(app_config, "models", None) or []
return models[0].name if models else None
def build_context_usage_payload(*, token_count: int, max_context_tokens: int | None) -> dict[str, Any]:
"""Build the stable API payload for a message count and model capacity."""
percentage: float | None = None
if max_context_tokens and max_context_tokens > 0:
percentage = round(token_count / max_context_tokens * 100, 1)
return {
"token_count": token_count,
"max_context_tokens": max_context_tokens,
"percentage": percentage,
}
async def build_context_usage(request: Request, thread_id: str, run_store: Any) -> dict[str, Any] | None:
"""Return approximate usage for the latest materialized thread checkpoint."""
try:
app_config = get_config()
except HTTPException:
return None
try:
accessor, checkpoint_config = await build_thread_checkpoint_state_accessor(request, thread_id=thread_id)
messages = await _load_checkpoint_messages(accessor, checkpoint_config)
except Exception:
logger.warning("Failed to load checkpoint for context usage on thread %s", thread_id, exc_info=True)
return None
try:
token_count = await asyncio.to_thread(_count_messages_approximately, messages)
except Exception:
logger.warning("Failed to count context messages for thread %s", thread_id, exc_info=True)
return None
model_name = await _resolve_thread_model_name(run_store, thread_id, app_config)
model_config = app_config.get_model_config(model_name) if model_name else None
configured_window = getattr(model_config, "context_window", None) if model_config is not None else None
max_context_tokens = int(configured_window) if configured_window else None
return build_context_usage_payload(token_count=token_count, max_context_tokens=max_context_tokens)