lemony-ai/cascadeflow
GitHubCascadeFlow通过草稿/验证器级联和17+领域感知模型分配,降低LLM调用成本与延迟。支持OpenClaw原生事件处理、流式响应及多步智能体循环,提供安全默认配置与快速安装指南。
Install All Skills
npx skills add lemony-ai/cascadeflow --all -g -y
More Options
List skills in collection
npx skills add lemony-ai/cascadeflow --list
Skills in Collection (2)
examples/integrations/openclaw/cascadeflow-clawhub/SKILL.md
npx skills add lemony-ai/cascadeflow --skill cascadeflow -g -y
SKILL.md
Frontmatter
{
"name": "cascadeflow",
"description": "OpenClaw-native domain cascading. Use when users need cost\/latency reduction via cascading, domain-aware model assignment, OpenClaw-native event handling, and command setup including \/model cflow and optional \/cascade stats commands."
}
CascadeFlow: Cost + Latency Reduction | 17+ Domain-Aware Models + OpenClaw-Native Events
Use CascadeFlow as an OpenClaw provider to lower cost and latency via cascading. Assign up to 17 domain-specific models (for coding, web search, reasoning, and more), including OpenClaw-native event handling, and cascade between them (small model first, verifier when needed). Keep setup minimal, then verify with one health check and one chat call.
Why Use It
- Reduce spend with drafter/verifier cascading.
- Run 17+ domain-aware model assignments (code, reasoning, web-search, and more).
- Support cascading with streaming and multi-step agent loops.
- Handle OpenClaw-native event/domain signals for smarter model selection.
Security Defaults
- Install from PyPI and verify package artifact before first run.
- Keep the server bound to localhost by default.
- Use explicit auth tokens for chat and stats endpoints (recommended for production).
- Expose remote access only behind TLS/reverse proxy with strong tokens.
- Use least-privilege provider keys (separate test keys from production keys).
How It Works
- OpenClaw sends requests to CascadeFlow through OpenAI-compatible
/v1/chat/completions. - CascadeFlow reads prompt context plus OpenClaw-native event/domain metadata (for example
metadata.method,metadata.event, and channel/category hints). - CascadeFlow selects a domain-aware drafter/verifier pair (small model first).
- If quality passes threshold, drafter answer is returned (cost/latency advantage).
- If quality fails threshold, verifier runs and final answer is upgraded.
- The same cascading behavior is supported for streaming and multi-step agent loops.
Advantages
- Lower average cost by avoiding verifier calls when not needed.
- Lower average latency for simple and medium tasks.
- Better quality on hard tasks through verifier fallback.
- Better operational handling through OpenClaw-native event/domain understanding.
Quick Start
Or ask your OpenClaw agent to set it up for you as an OpenClaw custom provider with OpenClaw-native events and domain understanding.
- Install and verify package source:
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade "cascadeflow[openclaw]>=0.7,<0.8"
python -m pip show cascadeflow
python -m pip download --no-deps "cascadeflow[openclaw]>=0.7,<0.8" -d /tmp/cascadeflow_pkg
python -m pip hash /tmp/cascadeflow_pkg/cascadeflow-*.whl
Optional variants:
python -m pip install --upgrade "cascadeflow[openclaw,anthropic]>=0.7,<0.8" # Anthropic-only preset
python -m pip install --upgrade "cascadeflow[openclaw,openai]>=0.7,<0.8" # OpenAI-only preset
python -m pip install --upgrade "cascadeflow[openclaw,providers]>=0.7,<0.8" # Mixed preset
- Pick preset + credentials:
- Presets:
examples/configs/anthropic-only.yaml,examples/configs/openai-only.yaml,examples/configs/mixed-anthropic-openai.yaml - Provider key(s):
ANTHROPIC_API_KEY=...and/orOPENAI_API_KEY=...(required based on selected preset) - Service tokens:
--auth-token ...and--stats-auth-token ...(recommended for production; use long random values)
- Start server (safe local default):
set -a; source .env; set +a
python3 -m cascadeflow.integrations.openclaw.openai_server \
--host 127.0.0.1 --port 8084 \
--config examples/configs/anthropic-only.yaml \
--auth-token local-openclaw-token \
--stats-auth-token local-stats-token
Optional harness activation (runtime in-loop policy controls):
# Observe first (recommended): log decisions, no blocking
python3 -m cascadeflow.integrations.openclaw.openai_server \
--host 127.0.0.1 --port 8084 \
--config examples/configs/anthropic-only.yaml \
--harness-mode observe
# Enforce mode with limits
python3 -m cascadeflow.integrations.openclaw.openai_server \
--host 127.0.0.1 --port 8084 \
--config examples/configs/anthropic-only.yaml \
--harness-mode enforce \
--harness-budget 1.0 \
--harness-max-tool-calls 12 \
--harness-max-latency-ms 3500 \
--harness-compliance strict
- Configure OpenClaw provider:
baseUrl:http://<cascadeflow-host>:8084/v1(local default:http://127.0.0.1:8084/v1)- If remote:
http://<server-ip>:8084/v1orhttps://<domain>/v1(TLS/reverse proxy) api:openai-completionsmodel:cascadeflowapiKey: same value as your--auth-token
Commands
/model cflow: default OpenClaw model switch using aliascflow./cascade: optional custom command (if configured in OpenClaw)./cascade savings: optional custom subcommand for cost stats./cascade health: optional custom subcommand for service status.
Links
- Full setup + configs:
references/clawhub_publish_pack.md - Listing strategy:
references/market_positioning.md - Official docs:
https://github.com/lemony-ai/cascadeflow/blob/main/docs/guides/openclaw_provider.md - GitHub repository:
https://github.com/lemony-ai/cascadeflow
skills/cascadeflow/SKILL.md
npx skills add lemony-ai/cascadeflow --skill cascadeflow -g -y
SKILL.md
Frontmatter
{
"name": "cascadeflow",
"description": "Use when building, extending, or debugging AI agents with cascadeflow (agent runtime intelligence layer) — installing `cascadeflow` (Python) or `@cascadeflow\/core`\/`@cascadeflow\/langchain` (TypeScript); using `CascadeAgent`, `ModelConfig`, harness APIs (`cascadeflow.init`, `cascadeflow.run`, `@agent` from `cascadeflow.harness`, `simulate`), `withCascade`\/`CascadeFlow`; picking drafter+verifier pairs; per-step budget\/compliance\/KPI enforcement; quality validation; complexity pre-routing; tool execution and multi-turn agent loops; presets; decision traces; or wiring cascadeflow into LangChain, OpenAI Agents, CrewAI, PydanticAI, Google ADK, n8n, or Vercel AI SDK. Also when a user mentions \"cascade\", \"drafter\/verifier\", \"runtime intelligence\", \"in-process harness\", \"cost-optimized agent\", \"agent loop with cost control\", is in the lemony-ai\/cascadeflow repo, or found a bug in cascadeflow\/integrations needing an upstream fix\/PR."
}
cascadeflow
What it is
Agent runtime intelligence layer. An in-process harness that sits inside the agent execution loop (not at the HTTP boundary) and makes per-step decisions on cost, latency, quality, budget, compliance, and energy. Sub-5ms overhead. Works alongside LangChain, OpenAI Agents SDK, CrewAI, PydanticAI, Google ADK, n8n, and Vercel AI SDK.
Two complementary pieces:
- Cascading — try a cheap "drafter" model first, validate quality, escalate to a "verifier" model only when needed (40–85% cost savings).
- Runtime intelligence (harness) — instrument the agent loop with budget caps, KPI weights, compliance gates, and a full per-step decision trace.
Python (pip install cascadeflow) and TypeScript (@cascadeflow/core). Docs: https://docs.cascadeflow.ai
Why "in the loop" matters (the core pitch)
cascadeflow is not a proxy or a gateway. It runs inside the agent's process and sees every model call, tool call, and sub-agent handoff as it happens — so it can act on running state (cost so far, tool calls used, compliance flag) at each step, not just per HTTP request.
| Dimension | External proxy | cascadeflow harness |
|---|---|---|
| Scope | HTTP request boundary | Inside the agent loop |
| What it can see | One request at a time | Full run state (cost-so-far, step #, tool-calls used, budget remaining) |
| Optimization axes | Cost only | Cost · latency · quality · budget · compliance · energy — simultaneously |
| Latency overhead | 10–50 ms network RTT per call | <5 ms in-process per call |
| 10-step agent loop | +400–600 ms avoidable | negligible |
| Enforcement | Observe only | allow · switch_model · deny_tool · stop |
| Auditability | Request logs | Per-step decision trace (one entry per LLM/tool/handoff decision) |
| Business logic | None | Live KPI weights + targets injected at runtime |
This is what unlocks: stop-after-step-7 budget enforcement, deny-this-tool-mid-loop, switch-models-on-this-call, and a full audit trail of why every step did what it did. None of that is possible from outside the loop.
When to use this skill
- User is building an AI agent and wants cost/latency/quality control inside the loop
- Code imports
cascadeflow,@cascadeflow/core,@cascadeflow/langchain,@cascadeflow/vercel-ai, or@cascadeflow/n8n-nodes-cascadeflow - Mentions budgets, compliance (GDPR/HIPAA/PCI), KPI weights, tool-call routing, decision traces, drafter/verifier — together with a cascadeflow signal (import, repo path, or explicit cascadeflow mention). Don't fire on unrelated compliance/budget conversations in user code.
- Working inside
lemony-ai/cascadeflow(examples, integrations, gateway server) - A bug is discovered in cascadeflow itself or any of its integrations and needs to be fixed upstream
Pick the right entry point (30-second decision)
| Situation | Use | File/pattern |
|---|---|---|
| Existing OpenAI/Anthropic app, want instant observability | cascadeflow.init(mode="observe") |
Auto-patches the SDKs. Zero code changes in the app. |
| Existing app, no code changes at all, want gateway | python -m cascadeflow.server |
Drop-in OpenAI/Anthropic-compatible proxy; point client at http://127.0.0.1:<port>/v1 |
| New agent, want the default "just works" cascade | auto_agent() or get_cost_optimized_agent() |
Presets — fastest path; no model picking required |
| New agent, custom drafter+verifier | CascadeAgent(models=[drafter, verifier]) |
Both languages |
| Agent function with budget + policy metadata | from cascadeflow.harness import agent then @agent(budget=..., compliance=..., kpi_weights=...) |
Attaches metadata; combine with cascadeflow.run() for enforcement. Note: import the decorator from cascadeflow.harness — cascadeflow.agent resolves to the module, not the decorator. |
| Scoped run with budget and full trace | with cascadeflow.run(budget=0.50, max_tool_calls=10) as session: |
Primary harness pattern |
| Inside LangChain / OpenAI Agents / CrewAI / PydanticAI / Google ADK / Vercel AI / n8n | Use the integration package | Don't reinvent — the integrations preserve tool calling, streaming, callbacks |
Minimum viable cascade
Python:
from cascadeflow import CascadeAgent, ModelConfig
agent = CascadeAgent(models=[
ModelConfig(name="gpt-4o-mini", provider="openai", cost=0.000375), # drafter
ModelConfig(name="gpt-4o", provider="openai", cost=0.00625), # verifier
])
result = await agent.run("What's the capital of France?")
print(result.content, result.model_used, result.total_cost, result.cost_saved)
TypeScript:
import { CascadeAgent } from '@cascadeflow/core';
const agent = new CascadeAgent({
models: [
{ name: 'gpt-4o-mini', provider: 'openai', cost: 0.000375 },
{ name: 'gpt-4o', provider: 'openai', cost: 0.00625 },
],
});
const r = await agent.run('What is TypeScript?');
console.log(r.modelUsed, r.totalCost, r.savingsPercentage);
Even faster — presets (Python):
from cascadeflow import auto_agent, get_cost_optimized_agent
agent = auto_agent() # picks a sensible pair
# or: get_cost_optimized_agent(), get_balanced_agent(),
# get_quality_optimized_agent(), get_speed_optimized_agent(),
# get_development_agent()
Runtime intelligence — the harness
This is what makes cascadeflow different from a proxy or a model router. The harness runs inside the agent loop and decides per step.
Three modes, safe rollout
off— no instrumentation (default)observe— patches OpenAI + Anthropic SDKs, records cost/tokens/decisions, enforces nothingenforce— same, plus applies actions (see below)
Per-step actions the harness can take
allow · switch_model · deny_tool · stop
Every LLM call, tool call, and sub-agent handoff is a decision point. The harness reads the current run state (cost so far, budget remaining, compliance flag, KPI weights) and chooses one of the four actions.
Stop reasons (verbatim strings on the trace + on HarnessStopError.reason):
budget_exceeded · max_tool_calls_reached · compliance_no_approved_model · latency_limit_exceeded · energy_limit_exceeded
Handling stops gracefully (don't crash the demo)
In enforce mode the harness raises a typed exception when it stops a run. Catch them inside a with cascadeflow.run(...) as session: block so the agent can summarize and exit cleanly:
from cascadeflow.schema.exceptions import BudgetExceededError, HarnessStopError
with cascadeflow.run(budget=0.10, max_tool_calls=5) as session:
try:
result = await agent.run(query)
except BudgetExceededError as e:
print(f"Stopped: budget exceeded. Remaining: ${e.remaining:.4f}")
except HarnessStopError as e:
print(f"Stopped: {e.reason}") # e.g. "max_tool_calls_reached"
finally:
print(session.summary()) # cost/steps/tool_calls captured up to the stop
session.save("run.jsonl") # full trace still exportable
max_latency_ms is cumulative across the run (not per step) — latency_used_ms accumulates and triggers latency_limit_exceeded when it crosses the cap.
Scoped runs with budget + trace (the demo-worthy pattern)
import cascadeflow
cascadeflow.init(mode="enforce") # or "observe" while you tune
with cascadeflow.run(
budget=0.50, # hard USD cap
max_tool_calls=10,
max_latency_ms=15000, # cumulative across the run
max_energy=None,
kpi_weights={"quality": 0.6, "cost": 0.3, "latency": 0.1},
compliance="gdpr", # blocks non-compliant models
) as session:
result = await agent.run("Analyze this dataset")
print(session.summary()) # see shape below
for entry in session.trace(): # per-step decision audit
print(entry)
session.save("run.jsonl") # exportable trace — great for demos / submissions
Shapes you'll actually print
session.summary() → dict:
{
"run_id": "ab12cd34ef56", "mode": "enforce", "step_count": 7, "tool_calls": 3,
"cost": 0.0421, "savings": 0.0118, "latency_used_ms": 4820.4, "energy_used": 0.0,
"budget_max": 0.50, "budget_remaining": 0.4579,
"last_action": "allow", "model_used": "gpt-4o-mini", "duration_ms": 5103.2,
}
session.trace() → list of dicts, one per decision:
{
"action": "switch_model", # allow | switch_model | deny_tool | stop
"reason": "budget_pressure", # human-readable; on stop it's the reason code
"model": "gpt-4o-mini",
"run_id": "ab12cd34ef56",
"mode": "enforce",
"step": 4,
"timestamp_ms": 1730000123456.0,
"tool_calls_total": 2,
"cost_total": 0.0312,
"latency_used_ms": 2400.1,
"energy_used": 0.0,
"budget_state": {"max": 0.50, "remaining": 0.4688},
"applied": true, # false for observe-mode "would have"
"decision_mode": "pre_call", # optional
}
session.save("run.jsonl") writes one session-header line + one trace line per decision. HarnessRunContext.load("run.jsonl") reads it back as {"session": ..., "traces": [...]}.
Policy metadata on agent functions
from cascadeflow.harness import agent # NOT `cascadeflow.agent` — that resolves to the module
@agent(
budget=0.20,
kpi_weights={"quality": 0.6, "cost": 0.3, "latency": 0.1},
compliance="gdpr",
)
async def my_agent(query: str): ...
The @agent decorator attaches metadata — it doesn't change the function's runtime by itself. Combine with cascadeflow.init(mode="enforce") and/or cascadeflow.run(...) to enforce. Works on sync or async functions. (cascadeflow.harness_agent is the same decorator re-exported at the top level if you prefer not to import from cascadeflow.harness.)
Zero-code config (env + file)
All harness settings also read from env vars and a config file — so students can demo observe → enforce rollout without touching code.
export CASCADEFLOW_HARNESS_MODE=enforce
export CASCADEFLOW_HARNESS_BUDGET=0.50
export CASCADEFLOW_HARNESS_MAX_TOOL_CALLS=10
export CASCADEFLOW_HARNESS_KPI_WEIGHTS='{"quality":0.6,"cost":0.3,"latency":0.1}'
# or point at a file:
export CASCADEFLOW_CONFIG=./cascadeflow.yaml
Precedence: explicit kwargs > env > config file > defaults. HarnessInitReport.config_sources tells you which source won.
Simulate before running (for tuning and pitch slides)
simulate(queries, models, quality_threshold=0.7, domain_detection=True) replays a list of queries through the deterministic complexity + domain routing pipeline — projecting which model would handle each query and the resulting cost/escalation rate — without making any provider calls.
from cascadeflow.harness import simulate
report = simulate(
queries=["What's 2+2?", "Write a poem about Paris", "Refactor this Python loop"],
models=[drafter_config, verifier_config],
quality_threshold=0.7,
)
print(report.projected_cost, report.escalation_rate, report.model_distribution)
queries accepts a list of strings or a path to a JSONL file with {"query": ...} lines (so a previously-saved session.save("run.jsonl") can also be replayed by extracting the queries from it). Use this to tune quality_threshold against representative traffic before turning on enforce mode.
Agent loops — tools, multi-turn, multi-agent
cascadeflow's harness is built for multi-step agents, not just single calls.
- Tool calling — universal tool format across providers; drafter can be pinned for simple tool calls while verifier handles complex reasoning.
- Multi-turn loops — automatic tool call → result → re-prompt with full history preservation (
tool_calls,tool_call_idpreserved across turns). - Per-tool-call gating — block or re-route tools based on risk/complexity (TS:
tool-risk.ts,ToolRouter). - Agent-as-a-tool / multi-agent — delegate sub-tasks to other agents; each sub-call runs through the same harness (sub-call decisions show up on the parent's trace).
- Hooks & callbacks — register a
CallbackManagerto stream cost/decision events to a dashboard. - Self-improving — because the harness sees every step, every tool result, and every quality score over time, it accumulates the data needed to tune routing strategies and escalation thresholds. Long-lived agents get smarter the more they run.
Wiring tools to the agent (Python)
from cascadeflow import CascadeAgent, ModelConfig
from cascadeflow.tools import ToolConfig, ToolExecutor
def get_weather(city: str) -> str:
return f"{city}: 18°C, cloudy" # mock
tool_configs = [
ToolConfig(
name="get_weather",
description="Get current weather for a city.",
parameters={
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"],
},
function=get_weather,
),
]
executor = ToolExecutor(tool_configs)
agent = CascadeAgent(
models=[
ModelConfig(name="gpt-4o-mini", provider="openai", cost=0.000375),
ModelConfig(name="gpt-4o", provider="openai", cost=0.00625),
],
tool_executor=executor, # executor goes on the agent
)
# Schemas (no function ref) go on the call:
schemas = [{"name": t.name, "description": t.description, "parameters": t.parameters}
for t in tool_configs]
result = await agent.run("What's the weather in Paris?", tools=schemas)
Streaming decision events to a dashboard
import cascadeflow
from cascadeflow.telemetry.callbacks import CallbackManager, CallbackEvent
manager = CallbackManager()
def on_decision(data):
# data.event, data.query, data.data — push to your dashboard / Slack / OTel
print(data.event.value, data.data)
manager.register(CallbackEvent.CASCADE_DECISION, on_decision)
manager.register(CallbackEvent.MODEL_CALL_COMPLETE, on_decision)
cascadeflow.init(mode="enforce", callback_manager=manager)
Available events: QUERY_START, COMPLEXITY_DETECTED, MODEL_CALL_START, MODEL_CALL_COMPLETE, MODEL_CALL_ERROR, CASCADE_DECISION, CACHE_HIT/MISS, QUERY_COMPLETE, QUERY_ERROR. For LangChain, prefer get_cascade_callback() (covered below).
Starter examples in the repo (all exist — verified):
| Pattern | Python | TypeScript |
|---|---|---|
| Tool execution | examples/tool_execution.py |
packages/core/examples/nodejs/tool-execution.ts |
| Multi-turn tool loop | examples/multi_step_cascade.py |
packages/core/examples/nodejs/agentic-multi-agent.ts |
| Streaming tools | examples/streaming_tools.py |
packages/core/examples/nodejs/streaming-tools.ts |
| Multi-agent / agent-as-a-tool | examples/agentic_multi_agent.py |
packages/core/examples/nodejs/agentic-multi-agent.ts |
| Harness + budget enforcement | examples/enforcement/basic_enforcement.py |
— |
| User budget tracking | examples/user_budget_tracking.py |
— |
| Guardrails | examples/guardrails_usage.py |
— |
| Rate limiting | examples/rate_limiting_usage.py |
— |
Picking drafter + verifier (the decision that decides savings)
The drafter should be ~8–20× cheaper than the verifier and actually able to answer the common case. If the drafter is too weak, escalation rate climbs and savings collapse.
| Use case | Drafter | Verifier |
|---|---|---|
| General chat (OpenAI) | gpt-4o-mini |
gpt-4o or gpt-5 |
| Cross-provider | claude-haiku / gpt-4o-mini |
claude-sonnet-4-5 / gpt-5 |
| Code / reasoning | gpt-4o-mini |
Reasoning model (o-series, claude-sonnet-4-5, deepseek-r1) |
| Local / edge | Ollama small (llama3.1:8b, qwen2.5:7b) |
Local large or cloud fallback |
TS helpers to pick from your configured LangChain models (all real — exported from @cascadeflow/langchain):
import {
findBestCascadePair, discoverCascadePairs, analyzeModel,
validateCascadePair, analyzeCascadePair, suggestCascadePairs,
} from '@cascadeflow/langchain';
Pre-routing by complexity (TS)
For agents where most queries are simple and a few are hard, pre-route so HARD queries skip the drafter entirely and go straight to the verifier.
import { PreRouter, ComplexityDetector } from '@cascadeflow/langchain';
// PreRouter config uses ComplexityDetector to classify SIMPLE / MEDIUM / HARD
Python equivalent: ComplexityDetector, QueryComplexity from cascadeflow.quality.complexity.
Quality validation
Default: length + confidence (logprobs) + format checks. Opt in to ML-based semantic similarity for better escalation decisions:
- Python:
pip install cascadeflow[semantic]→from cascadeflow.quality.semantic import SemanticQualityChecker - TS:
npm install @cascadeflow/ml @huggingface/transformers, thenquality: { useSemanticValidation: true, semanticThreshold: 0.5 }onCascadeAgent
Tune qualityThreshold (TS) / quality_threshold (Py) to hit a target drafter-handled rate. 0.6-0.8 is a reasonable starting range. Higher threshold means more escalations and less savings.
Multi-tenant demos — user profiles & tiers
from cascadeflow import UserProfile, UserProfileManager, TierLevel, TIER_PRESETS
# Per-user budget enforcement, tier-aware routing (FREE/STARTER/PRO/BUSINESS/ENTERPRISE)
See examples/user_profile_usage.py and examples/user_budget_tracking.py. Useful for SaaS-style demos and multi-tenant product flows.
Framework integrations (pick one, don't reinvent)
All of the following exist in the repo — verified on current main:
| Framework | Package / module | Entry point |
|---|---|---|
| LangChain (TS) | @cascadeflow/langchain |
withCascade({ drafter, verifier, qualityThreshold }) |
| LangChain (Py) | cascadeflow.integrations.langchain |
CascadeFlow(drafter=..., verifier=..., quality_threshold=...) |
| LangChain callbacks (Py) | cascadeflow.integrations.langchain.langchain_callbacks |
get_cascade_callback() |
| OpenAI Agents SDK | cascadeflow.integrations.openai_agents |
See examples/integrations/openai_agents_harness.py |
| CrewAI | cascadeflow.integrations.crewai |
See examples/integrations/crewai_harness.py |
| PydanticAI | cascadeflow.integrations.pydantic_ai |
See examples/integrations/pydantic_ai_harness.py |
| Google ADK | cascadeflow.integrations.google_adk |
See examples/integrations/google_adk_harness.py |
| n8n | @cascadeflow/n8n-nodes-cascadeflow |
CascadeFlow Model + CascadeFlow Agent nodes |
| Vercel AI SDK | @cascadeflow/vercel-ai |
Middleware for ai package; 17+ extra providers |
| OTel / Grafana | cascadeflow.integrations.otel |
See examples/integrations/opentelemetry_grafana.py |
| LiteLLM | cascadeflow.integrations.litellm |
See examples/integrations/litellm_providers.py |
When adding cascadeflow to a project already using one of these, prefer the integration package over raw CascadeAgent — keeps tool calling, streaming, and callbacks working.
Common pitfalls
- The
@agentdecorator alone does nothing at runtime. It attaches metadata. Pair withcascadeflow.init(mode="enforce")and/orcascadeflow.run(...)to actually enforce budgets/compliance. - Don't write
@cascadeflow.agent(...)— it raisesTypeError: 'module' object is not callable.cascadeflow.agentis the module file, not the decorator. Usefrom cascadeflow.harness import agentand@agent(...), or@cascadeflow.harness_agent(...). observemode does not stop on overrun. Switch toenforce(or wrap incascadeflow.run(budget=...)) to actually cut off.- Drafter too weak → escalation rate ~100%. Log
result.model_usedon a sample; if the drafter is never "accepted", lowerquality_thresholdor upgrade the drafter. - Pairing two models of similar price. No meaningful savings. Pick drafter and verifier from different tiers.
- Per-provider auth. cascadeflow does not proxy auth. Each provider still needs its own
OPENAI_API_KEY,ANTHROPIC_API_KEY, etc. - GPT-5 streaming requires org verification. Non-streaming works for all users. If streaming breaks during a demo, flip to non-streaming or pick a different verifier.
- Forgetting
[all]extras.pip install cascadeflow[all]pulls every provider + semantic validation. Otherwise install per-provider extras ([openai],[anthropic],[groq],[together],[vllm],[huggingface],[local],[semantic],[langchain],[crewai]). - Expecting local clones to match docs. The GitHub README and PyPI package are authoritative. Check
cascadeflow.__version__and compare against latest release.
Prove the savings in your demo
print(f"Model used: {result.model_used}")
print(f"Cost: ${result.total_cost:.6f}")
print(f"Saved: ${result.cost_saved:.6f} ({result.cost_saved_percentage:.1f}%)")
print(f"Draft/verifier breakdown: ${result.draft_cost:.6f} / ${result.verifier_cost:.6f}")
For aggregate across a run: session.summary() (harness) or the LangChain callback:
from cascadeflow.integrations.langchain.langchain_callbacks import get_cascade_callback
with get_cascade_callback() as cb:
await cascade.ainvoke("...")
print(cb.total_cost, cb.drafter_cost, cb.verifier_cost, cb.total_tokens)
TS: result.savingsPercentage directly — use it in the UI.
Found a bug? Contribute the fix back
If you discover a bug inside cascadeflow itself (the cascadeflow Python package, @cascadeflow/core, or any integration package), the skill expects you to fix it upstream — fork, patch, push, open a PR — not paper over it locally. Everything ships from one monorepo: lemony-ai/cascadeflow.
If the bug is in your own app, this skill has no opinion — follow your project's normal workflow. The flow below is for upstream fixes only.
Where the code lives (so the agent doesn't guess)
| Where the bug is | Path in the monorepo |
|---|---|
| Python core | cascadeflow/ (e.g. cascadeflow/harness/instrument.py, cascadeflow/agent.py) |
| TypeScript core | packages/core/src/ |
| LangChain (TS) | packages/langchain-cascadeflow/src/ |
| LangChain (Py) | cascadeflow/integrations/langchain/ |
| OpenAI Agents (Py) | cascadeflow/integrations/openai_agents.py |
| CrewAI (Py) | cascadeflow/integrations/crewai.py |
| PydanticAI (Py) | cascadeflow/integrations/pydantic_ai/ |
| Google ADK (Py) | cascadeflow/integrations/google_adk.py |
| LiteLLM (Py) | cascadeflow/integrations/litellm.py |
| OTel (Py) | cascadeflow/integrations/otel.py |
| n8n | packages/integrations/n8n/ |
| Vercel AI SDK | packages/integrations/vercel-ai/ |
| ML (semantic quality) | packages/ml/ |
Upstream-fix workflow
# 0. Prerequisite: `gh auth login` (every gh command below needs it).
# Pin & verify it's not already fixed in latest:
python -c "import cascadeflow; print(cascadeflow.__version__)"
gh release list --repo lemony-ai/cascadeflow --limit 5
gh issue list --repo lemony-ai/cascadeflow --search "<keywords>"
# 1. Fork + clone (creates origin = your fork, upstream = lemony-ai)
gh repo fork lemony-ai/cascadeflow --clone --remote
cd cascadeflow
# 2. Install dev deps. THIS IS NOT OPTIONAL.
# The repo's pyproject pytest config injects --cov / --asyncio-mode=auto,
# so bare `pytest` fails on a fresh `pip install -e .` until you pull the dev extra.
pip install -e ".[dev]" # pulls pytest, pytest-cov, pytest-asyncio, ruff, black, mypy
# If the repo has a `.pre-commit-config.yaml` at the root, also run:
# pre-commit install
# CONTRIBUTING.md mentions this; check whether the config file exists first.
# 3. Branch off main — never push fixes to main
git checkout main && git pull upstream main
git checkout -b fix/<short-slug> # e.g. fix/harness-max-energy-none
# 4. Patch + add a regression test next to existing tests for that area
# 5. Run the right test suite
pytest # Python core / Python integrations
pnpm --filter @cascadeflow/core test # TS core
pnpm --filter @cascadeflow/langchain test # TS LangChain integration
# (substitute the package for whichever folder you touched)
# For watch mode during iteration: `pnpm --filter @cascadeflow/<pkg> test:watch` (if defined)
# 6. Stage everything (including the new test file) and commit. DO NOT use
# `git commit -am` — `-a` skips untracked files, so your regression test
# silently won't be in the commit and the PR will fail review.
git status # confirm new test file is listed under "Untracked"
git add <touched-files> <new-test-file>
git commit -m "fix(<area>): <one-line summary>"
# areas: harness, langchain, crewai, pydantic-ai, openai-agents,
# google-adk, n8n, vercel-ai, core, docs, etc.
# 7. Push to your fork and open the PR upstream
git push -u origin fix/<short-slug>
gh pr create --repo lemony-ai/cascadeflow --base main \
--title "fix(<area>): <one-line summary>" \
--body "Fixes #<issue>. <repro + what changed + test added>"
Every
gh ...command above requiresgh auth login. If unauthed, run that first, or substitute a web search ofgithub.com/lemony-ai/cascadeflow/issuesandgit log upstream/main -- <path>for the prior-fix check.
Unblock the demo while the PR is in review
Don't wait for the merge — install your patched fork into the app that needs the fix:
- Python:
pip install -e /path/to/your/cascadeflow-fork - TypeScript:
pnpm packinside the patched package, thennpm install /path/to/cascadeflow-<pkg>-x.y.z.tgzin the target app. (npm linkworks but is flaky with pnpm workspaces.)
After the PR merges and a release ships, swap back to the published package.
Don't
- Don't push fixes directly to
main(your fork or upstream). - Don't
--force-pushto a shared/upstream branch. - Don't bypass
pre-commitwith--no-verifyif a.pre-commit-config.yamlexists — fix the lint/format issue instead. - Don't
git commit -amwhen you've added a new test file —-askips untracked files. Usegit addthengit commit -m. - Don't run bare
pytestafterpip install -e .— the repo's pyproject injects--covand--asyncio-mode=auto. Install".[dev]"first. - Don't open a PR without a regression test for non-trivial fixes (single-line comment/typo fixes are fine without one).
- Don't commit API keys,
.envfiles, or local config.
Where to look next
- Docs: https://docs.cascadeflow.ai
- Python API: https://docs.cascadeflow.ai/api-reference/python/overview
- TypeScript API: https://docs.cascadeflow.ai/api-reference/typescript/overview
- Agent harness: https://docs.cascadeflow.ai/get-started/agent-harness
- Rollout guide (observe → enforce): https://docs.cascadeflow.ai/get-started/rollout-guide
- Providers + presets: https://docs.cascadeflow.ai/developers/providers-and-presets
- Python examples:
./examples/— start withbasic_usage.py,multi_step_cascade.py,tool_execution.py,enforcement/basic_enforcement.py - TS examples:
./packages/core/examples/nodejs/— start withbasic-usage.ts,tool-calling.ts,agentic-multi-agent.ts,cost-tracking.ts
Red flags — stop and re-check
- Writing your own retry/escalation loop around two model calls → use
CascadeAgentor a preset. - Hand-rolling budget tracking on top of OpenAI/Anthropic calls → use
cascadeflow.init(mode="enforce")+cascadeflow.run(budget=...). - Computing cost savings manually by subtracting hardcoded prices → use
result.total_cost/result.cost_saved/result.cost_saved_percentage, or the LangChain callback. - Drafter and verifier from the same tier (e.g.
gpt-4o+gpt-4o) → no meaningful savings. - Treating the
@agentdecorator as enforcement — it's metadata only. - Writing
@cascadeflow.agent(...)— that's the module, not the decorator. See the@agentimport note above. - Demoing
observemode and claiming "budget enforced" — observe doesn't stop calls. Useenforceorrun(budget=...).


