OpenSmartRoute
An open, intelligent route to the right decision, solution, or destination.
OpenSmartRoute is an open-source AI decision control plane. For each request it picks the best LLM, agent harness, skill, persona, tool, workflow or human, honours hard constraints (privacy, region, budget, latency), explains the choice, executes the resulting plan and learns from every outcome. The core is pure Python with zero runtime dependencies.
flowchart LR
R([request]) --> G["guard<br/>redact PII"]
G --> S["signals<br/>< 1 ms"]
S --> P["policy<br/>hard constraints"]
P --> ST["strategies + ensemble utility<br/>rules, capability, similarity, bandit, LLM judge"]
ST --> D["decision<br/>trace + plan"]
D --> X["execute<br/>persona -> skill -> model / agent / tool / human"]
X -. outcomes .-> ST
Why
- Everything is a route target. One
RouteTargetcontract for models, agent harnesses, SKILL.md packages, personas, MCP tools, workflows and human queues; one policy layer; one learning loop. - Plans, not just picks.
route(plan=True)composes persona, skill and model;run()executes the plan and records anOutcomeper participant. An instructions-only skill or persona runs on the plan's model with its body disclosed in the system prompt. - Constraints are never traded off. PII, data boundary, region, tenant, cost and latency SLOs are filtered before any score is computed, with the rejection reason in the trace. Redacted PII is restored only for targets allowed to hold it; every other target, and every log, sees placeholders.
- Learns in production. Thompson bandits, Item Response Theory, Bradley-Terry preferences, LinUCB, Markov lookahead, task-level credit assignment, drift detection and forgetting.
- Honest evaluation. Baselines, oracle, label-noise floor, paraphrase robustness, calibration (ECE, Brier, conformal sets), off-policy estimators, public benchmark presets.
- Secure by design. Learned and heuristic guards against rerouting gadgets and prompt injection, PII redaction, resource limits, signed MCP manifests, encrypted state, hash-chained audit.
- Enterprise-ready. Builder, middleware, telemetry / state / audit ports, Redis and SQL stores, shadow and A/B routing with SPRT, tenant fair share, async facade, container image and Helm chart.
Install
The osr command line and the Python package ship together. On Linux and macOS:
curl -LsSf https://opensmartroute.ai/install.sh | sh
On Windows (PowerShell):
powershell -ExecutionPolicy ByPass -c "irm https://opensmartroute.ai/install.ps1 | iex"
The installer puts osr in an isolated environment (uv, pipx or a private venv - whichever is
available, never the system Python) and adds it to your PATH. OSR_VERSION=0.5.0 pins a release,
OSR_EXTRAS=all installs every optional dependency, OSR_INSTALLER=uv|pipx|venv forces a backend and
OSR_NO_MODIFY_PATH=1 leaves your shell configuration alone. The scripts are
install.sh and install.ps1 in this repository and attached to every
GitHub release.
If you already manage Python tools yourself:
uv tool install 'opensmartroute[yaml,server]' # or: pipx install 'opensmartroute[yaml,server]'
pip install opensmartroute # library only, zero runtime dependencies
pip install 'opensmartroute[yaml]' # + YAML catalogues and rules
pip install 'opensmartroute[server]' # + FastAPI server and OpenAI-compatible proxy
pip install 'opensmartroute[embeddings]' # + sentence-transformers similarity
pip install 'opensmartroute[otel]' # + OpenTelemetry telemetry
pip install 'opensmartroute[crypto]' # + AES-GCM encrypted state
Container image: ghcr.io/isathish/opensmartroute:<version> (deploy/README.md).
From a checkout: pip install -e '.[dev]'.
Then sign in. The hosted platform (community or enterprise edition) uses a browser hand-shake; a
self-hosted osr serve accepts a token you generate yourself:
osr login # opens https://opensmartroute.ai/cli/authorize
osr login --url https://osr.example.com # your own platform deployment
osr login --url http://router:8000 --token osr_local_... # self-hosted server (see `osr serve --generate-token`)
osr whoami # workspace, plan, edition, key
Credentials live in ~/.config/opensmartroute/credentials.json (%APPDATA%\opensmartroute on
Windows), one profile per --profile; OSR_API_URL / OSR_API_KEY override them in CI.
Quick start
from opensmartroute import Router, TargetRegistry, RouteTarget, TargetKind, Capabilities, Outcome
registry = TargetRegistry([
RouteTarget("llm-small", TargetKind.LLM,
capabilities=Capabilities(max_complexity=0.45),
cost={"usd_per_1k_tokens": 0.0002}, latency_ms=300, quality_prior=0.55,
examples=["Hi, how are you?", "What is the capital of France?"]),
RouteTarget("llm-frontier", TargetKind.LLM,
capabilities=Capabilities(min_complexity=0.5, domains=["math", "coding"]),
cost={"usd_per_1k_tokens": 0.015}, latency_ms=2500, quality_prior=0.93,
examples=["Prove the theorem step by step."]),
RouteTarget("human", TargetKind.HUMAN,
capabilities=Capabilities(actions=["escalate"], tags=["safety"]),
cost={"usd_per_1k_tokens": 0.5}, latency_ms=300_000),
])
router = Router(registry)
d = router.route("Prove that sqrt(2) is irrational, step by step.")
print(d.target.id, f"{d.confidence:.2f}") # llm-frontier 0.97
print(d.trace.explain()) # per-strategy scores and rationales
router.learn(Outcome(request_id=d.request_id, target_id=d.target.id, success=True,
quality=0.9, cost_usd=0.002, latency_ms=1800, domains=d.trace.signals.domains))
Hard constraints and a per-request objective:
from opensmartroute import RouteRequest, RequestConstraints, Objective
req = RouteRequest("Summarize this patient intake note.",
constraints=RequestConstraints(region="eu", data_boundary="private", max_cost_per_1k=0.005),
objective=Objective(quality=1.0, cost=0.5, latency=0.1, quality_floor=0.6))
d = router.route(req)
print(d.trace.policy_rejections) # {'llm-frontier': 'cost 0.015 > budget 0.005', ...}
Catalogue and rules from YAML, evaluated and served from the command line:
osr -t examples/targets.yaml -r examples/rules.yaml route "I want a refund for order #123" --plan
osr -t examples/targets.yaml -r examples/rules.yaml eval examples/eval_dataset.jsonl --frontier
osr -t examples/targets.yaml -r examples/rules.yaml serve # http://127.0.0.1:8000/docs
Wiring real providers, executing plans with router.run(), agent harnesses, SKILL.md and MCP
catalogues, the decorator SDK and the enterprise builder are covered step by step in
docs/GUIDE.md.
What it routes
| Kind | Examples | Executed by |
|---|---|---|
llm |
model endpoints, per reasoning effort or token budget | OpenAI-compatible client or any callable |
agent |
coding, research and support harnesses with tools and memory | callable, HTTP or subprocess harness |
skill |
deterministic capabilities, SKILL.md packages | your function; instructions disclosed to the model |
persona |
system-prompt layers composed on top of the primary target | run() prompt composition |
tool |
MCP or function tools, with schema-aware matching | tool call |
workflow |
fixed multi-step pipelines | workflow engine |
human |
queues and experts with Erlang-C capacity maths | ticketing or hand-off; also the abstention target |
Catalogues load from YAML or JSON, MCP tools/list payloads, A2A agent cards, SKILL.md and persona
directories and vLLM semantic-router configurations; the router plugs into LangGraph and Agent
Framework graphs as a node and into any chat loop as an OpenAI tool.
How it decides
- Signals (under 1 ms): task type, domains, complexity, reasoning need, PII, language, modality, history; optional verbalised difficulty, cheap-draft features and hidden-state probes.
- Policy: hard constraints filter targets before any scoring.
- Strategies: rules, capability fit, example similarity, task table, Thompson and LinUCB bandits,
IRT, Bradley-Terry, Markov lookahead, multi-turn history embeddings, learning-to-defer, edge/cloud
tiers, token budgets, auctions, user adaptation and an LLM judge consulted only below a confidence
threshold; optionally a routing SLM (
RouterSLM) distilled from the whole ensemble that keeps improving on its own from outcomes, public routing datasets and a live model catalogue (guide). - Utility: confidence-weighted ensemble, then
w_q * quality - w_c * norm(cost) - w_l * norm(latency)with a hard quality floor; temperature scaling and conformal candidate sets calibrate the confidence; the router abstains when nothing is safe enough. - After the answer: cascades and self-escalation stop or reroute on response-side uncertainty (semantic entropy, P(True), streaming competence posterior); mixture-of-agents aggregation and permanent hand-off policies cover agentic trajectories.
Formulas and citations: docs/MATH.md, docs/RESEARCH.md.
Production
from opensmartroute import RouteRequest, RequestConstraints
from opensmartroute.enterprise import RouterBuilder, MetricsTelemetry, FileAuditSink, TenantMiddleware
from opensmartroute.security import GuardMiddleware
app = (RouterBuilder(registry)
.with_defaults().with_auto_learning(state_dir=".osr-state")
.with_health(latency_slo_ms=3000)
.with_middleware(GuardMiddleware(redact=True),
TenantMiddleware({"acme": {"deny_targets": ["llm-frontier"]},
"globex": {"data_boundary": "on_prem"}}))
.with_telemetry(MetricsTelemetry()).with_audit(FileAuditSink("audit.jsonl"))
.build())
req = RouteRequest("Prove that sqrt(2) is irrational.", constraints=RequestConstraints(tenant="acme"))
d = app.route(req) # guard -> tenant -> policy -> strategies; audited and measured
result = app.run(req) # ...then executes the plan once targets carry handlers, and learns
print(d.target.id, app.health_snapshot())
Routing overhead is 6 ms p50 with the default strategies and 9 ms with every learner enabled on a
16-target catalogue; retrieve-then-rank keeps it flat for thousands of tools
(measurements). osr serve (or create_app(app) with the
router above) exposes a FastAPI app and an OpenAI-compatible /v1/chat/completions proxy: point any
OpenAI client at it with model="auto"; guard and tenant violations return 400, no admissible target
422, an unreachable provider 503. Circuit breakers open on provider failures and recover on their own;
learner state survives restarts from state_dir or a Redis / SQL store. Deployment references:
deploy/README.md, docs/ENTERPRISE.md.
Hosted platform
platform/ packages the router as a service in two containers: osr-platform-api
(FastAPI: self-serve signup with hashed API keys, plans and quotas, usage metering, the metered
/api/v1/route family with the full trace, per-tenant constraints and workspace policy, the audit
trail, per-request traces and a live event stream, and the OpenAI-compatible /v1/chat/completions
proxy) and osr-platform-web (Next.js: landing page, the rendered documentation, pricing, a live
playground and the account dashboard with activity, events, governance and health pages; it proxies
/api and /v1 so the browser only talks to one origin). OSR_PLATFORM_EDITION=community runs the core
Router; enterprise runs the builder above with auto-learning, health, guard, metrics, a
hash-chained audit log and per-tenant constraints. azd up deploys both to Azure Container Apps with
Azure OpenAI from infra/; the reference deployment is
https://osr-web.gentlepebble-235bed4c.swedencentral.azurecontainerapps.io. The end-user guide is
docs/PLATFORM.md; the REST API reference is generated from
platform/api/openapi.json.
curl -s -XPOST $OSR/api/v1/signup -H 'content-type: application/json' -d '{"email":"you@example.com"}'
curl -s $OSR/api/v1/route -H "authorization: Bearer $KEY" -H 'content-type: application/json' \
-d '{"text":"Prove that sqrt(2) is irrational."}'
Security
Routing is a control plane; its integrity is a security property. InputGuard combines a heuristic
and a learned detector for confounder gadgets that reroute queries, an injection-risk scorer, PII
redaction and prompt sanitisation for the LLM judge. Per-task resource limits, an origin policy for
sensitive tool parameters, signed MCP manifests, AES-GCM state, content-free logs and hash-chained
audit complete the model. CI runs ruff -S, mypy, bandit, CodeQL and the osr safety red-team
suite. Threat model: docs/SECURITY.md. Reporting: SECURITY.md.
Documentation
The user documentation is a searchable, versioned site at https://osr-web.gentlepebble-235bed4c.swedencentral.azurecontainerapps.io/docs (built from these files at release time, with a REST API reference generated from the platform's OpenAPI document). It covers the hosted platform, the Python SDK and the pip package; the internal planning, go-to-market, brand and sales documents below stay in the repository only.
| Document | Contents |
|---|---|
| docs/GUIDE.md | User guide: targets, routing, execution, providers, learning, SDK, enterprise builder, research-track modules, CLI, latency, layout |
| docs/PLATFORM.md | Platform guide: authentication, /api/v1/route, execution, the OpenAI-compatible endpoint, feedback, plans and quotas, organizations, tenants, governance, observability (traces, events, readiness), the MCP server, dashboard |
| docs/MARKETPLACE.md | Marketplace: find, install, buy and publish agents, skills, personas, prompts and stack templates; ratings, review lifecycle, osr stack |
| docs/MCP.md | Cost estimates (estimate, POST /api/v1/estimate), recommended models per use case and the MCP server for VS Code, Cursor, Claude, Windsurf and agents |
| docs/SDK.md | API reference for the decorator SDK, components and settings |
| docs/REFERENCE.md | Generated API reference: every module and exported name (python scripts/api_reference.py) |
| docs/ARCHITECTURE.md | Request path, module boundaries, performance envelope |
| docs/ENTERPRISE.md | Ports, stores, middleware, shadow and A/B, multi-replica operation |
| docs/OBSERVABILITY.md | Tracing and observability: spans and events for every stage, sinks (memory, metrics, log, file, OpenTelemetry), /events, /trace, /metrics, OSR_OBSERVABILITY_*; the platform's per-workspace /api/v1/trace, /api/v1/events, /api/v1/status and dashboard pages |
| docs/MATH.md | Every formula the router uses, with derivations |
| docs/RESEARCH.md | Literature survey and the idea-to-module map |
| docs/SECURITY.md | Threat model and hardening checklist |
| docs/ROADMAP.md | Per-version exit criteria and status |
| docs/PLATFORM_PLAN.md | Platform strategy: agentic routing, Open Capability Manifest, marketplace, editions and pricing |
| docs/GO_TO_MARKET.md | Go-to-market plan; the sales enablement kit lives in docs/sales/ |
| spec/ocm/README.md | Open Capability Manifest specification and JSON Schema |
| deploy/README.md | Container image, Helm chart, reference deployments |
| platform/README.md | Hosted platform: api/ (FastAPI) and web/ (Next.js), playground, API keys, plans, editions, OSR_PLATFORM_* settings, Azure deployment |
| docs/BRAND.md | Logo system and naming conventions |
.claude/skills/ ships Agent-Skills packages that teach coding assistants how to use
and extend the project; they are also valid routing targets (osr skills validates them) and each one is
published on the documentation site under /docs/skills/. Coding agents working in this repository
start from AGENTS.md.
Roadmap
| Release | Theme | Status |
|---|---|---|
| 0.3 | Real integrations: OpenAI-compatible client, adapters, config loaders | Shipped |
| 0.4 | Learned signals and honest evaluation | Shipped |
| 0.5 | Target representations, effort and personalisation | Complete |
| 0.6 | Multi-step and agentic routing | Complete |
| 0.7 | Catalogue interop and discovery at scale | Complete |
| 0.8 | Operations, risk control and economics | Complete |
| 0.9 | Security hardening of the control plane | In progress |
| 1.0 | Stable API, external review, reference deployments | In progress |
Every item in the research track is implemented on main with tests; a version is Complete when
its measured exit criterion is published (python scripts/exit_criteria.py, 8/8 met) and Shipped
when it is in a tagged release. 0.9 waits on an external security review; 1.0 on two production users,
two stable minors and the public leaderboard runs (examples/leaderboard
is the reproducible recipe; the v0.4 public-suite measurement made with it is in the roadmap). Details in
docs/ROADMAP.md and CHANGELOG.md.
Contributing
Issues and pull requests are welcome; see CONTRIBUTING.md. CI runs ruff, mypy,
bandit and pytest on CPython 3.10 to 3.13 (Linux and Windows), a routing-accuracy gate and the
safety suite on the example catalogue, builds the distribution and the container image, and scans with
CodeQL. The test suite has no mocks of the router itself: tests/test_e2e_scenarios.py
drives the shipped example catalogue through an in-process OpenAI-compatible provider fleet over
HTTP, a real MCP server subprocess over stdio, the CLI, the FastAPI service, provider outages with
breaker recovery, agentic multi-round loops and concurrent traffic. Releases are automated: a release
pull request bumps the version and rolls the changelog; merging it tags, publishes to PyPI with
attestations and pushes the image.
License
Apache-2.0
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file opensmartroute-0.5.0.tar.gz.
File metadata
- Download URL: opensmartroute-0.5.0.tar.gz
- Upload date:
- Size: 823.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
417e2dace5f22e8cdc94e61ea32a7e3fc09479c275da4c65a8dbaa30ee7f1a29
|
|
| MD5 |
96725e8f9b08f37effa5b0fb062cd659
|
|
| BLAKE2b-256 |
ad80e96a0c868ed1d4ab83341881a9326939e7ba4073b6a8a17aa63160b7a018
|
File details
Details for the file opensmartroute-0.5.0-py3-none-any.whl.
File metadata
- Download URL: opensmartroute-0.5.0-py3-none-any.whl
- Upload date:
- Size: 489.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
845b0b0477f59880509351e4aa5c96f39405fe69b2008e463c4b643d0040b11e
|
|
| MD5 |
c5957e00a3cb69e4b356d15b2b67b59f
|
|
| BLAKE2b-256 |
e69f3e3d6313933522bf7aa8b64553022b8980b420d943f9c8b79c6974884da4
|