Skip to content

Locus workbench

A browser-based playground for every locus pattern. Two ways to run it — straight from source on your laptop, or inside a Docker container — both end at the same UI at http://localhost:5173.

View on GitHub Workbench README

Once it's up: open Provider settings, paste an OpenAI / Anthropic key or wire up an OCI profile, pick a notebook in the sidebar, hit Run. A real agent streams events back into the browser.

locus workbench

What it is

The workbench is the fastest way to see what locus does without installing anything locally. It's a single-page UI in front of every canonical locus pattern — a basic agent, an agent with tools, a structured-output schema, an orchestrator with specialists, a sequential pipeline, a map-reduce fan-out, a critic loop with allow_cycles. Each pattern is wired to a real Python coroutine that imports locus, builds the agent, and streams events through to your browser.

Start with Oracle

The catalog leads with the Oracle primitives category. Two runnable demos pinned to the top of the sidebar:

  • Oracle 26ai RAG (native VECTOR)OracleVectorStore against an Autonomous Database wallet, native VECTOR(1024, FLOAT32) + VECTOR_DISTANCE COSINE. Requires ORACLE_DSN / ORACLE_USER / ORACLE_PASSWORD / ORACLE_WALLET on the backend host (plus an OCI provider in the UI for embeddings). See notebook 06.
  • Retrieve-then-rerank (Cohere V4)CohereReranker on OCI on-demand rerank-v4. Provider panel set to OCI is enough. See notebook 05.

The notebook sidebar also surfaces the rest of the Oracle-native path — notebooks 01 / 02 / 03 (transports), 04 (Dedicated AI Cluster) — under the same "Oracle primitives" group.

Database settings (Oracle 26ai)

Provider settings now include a second panel for Oracle Database 26ai — fill it in once per tab and the workbench will route every Oracle-backed pattern (vector RAG, durable checkpoints) at your Autonomous Database. The panel collects five fields:

Field Example Notes
DSN mydb_low A tnsnames alias from inside the wallet directory.
User locus_app Use a least-privileged app schema, not ADMIN.
Password (secret) Sent only to the backend; never persisted.
Wallet path ~/.oci/wallets/mydb A directory on the backend's filesystem holding tnsnames.ora. See the Docker note below.
Wallet password (secret) Required only if the wallet bundle is encrypted.

Same trust model as the provider API key: held in browser-tab memory only, never written to localStorage, never sent anywhere except the local BFF on its way to the backend. Closing the tab clears everything.

Hit Test connection to validate. The backend opens a pool, runs SELECT 1 FROM dual, returns a green ✓ on success or the raw oracledb error string verbatim on failure — wallet TLS issues, DPY-… error codes, bad credentials, all surface here before you try to run a pattern.

Path vs upload. This release accepts a path that's already readable from the backend process. Uploading a wallet bundle through the browser is on the roadmap; the path mode covers the developer-on-localhost case today.

Docker

When the workbench backend runs in Docker (the default container image), the wallet path the user types into the panel is resolved inside the container, not on the host. Mount the wallet directory when starting the container:

docker run --rm -p 8100:8100 \
  -v $HOME/.oci/wallets/mydb:/wallets/mydb:ro \
  ghcr.io/oracle-samples/locus-workbench:latest

Then enter /wallets/mydb (the in-container path) in the Wallet path field. Same flow as the localhost run, with the only difference being the path namespace.

Backend env-var fallback

If the per-tab Database panel is empty, the backend falls back to ORACLE_DSN / ORACLE_USER / ORACLE_PASSWORD / ORACLE_WALLET (plus ORACLE_WALLET_PASSWORD) read from the process environment — matching the convention used by every Oracle-backed notebook under examples/. UI input always overrides the env when both are set.

It's also the canonical demo: visitors arrive at this app, pick a workflow, and learn the SDK by running real ones.

┌───────────────────────────────────────┐
│  workbench/web   — vanilla TS + Vite  │  :5173
│  Notebook catalog · provider settings │
└───────────────────┬───────────────────┘
                    │ /api/*
┌───────────────────────────────────────┐
│  workbench/bff   — Node Express       │  :3101
│  Same-origin proxy + cookie surface   │
└───────────────────┬───────────────────┘
                    │ /api/*
┌───────────────────────────────────────┐
│  workbench/backend — FastAPI runner   │  :8100
│  One endpoint per locus pattern       │
└───────────────────────────────────────┘

You paste your provider key once per tab — the workbench never persists API keys to localStorage, so closing the tab discards everything.

Run it locally (from source)

The dev-loop path. Best for iterating on the workbench code itself, debugging a pattern, or extending the runner.

Prerequisites

  • Python 3.11+ with pip (3.12 is what CI uses).
  • Node 20+ with npm.
  • A model provider — one of: an OPENAI_API_KEY, an ANTHROPIC_API_KEY, or a populated ~/.oci/config for OCI GenAI.

Step-by-step

git clone https://github.com/oracle-samples/locus.git
cd locus
pip install -e ".[server,oci,openai,anthropic]"  # core + provider extras

Three tiers, three terminals (or three tmux panes). They don't depend on each other at startup, but every tier expects the one downstream of it to come up within ~30 s:

# Terminal 1 — FastAPI runner (the actual workbench backend)
cd workbench/backend
python -m uvicorn --app-dir . runner:app --port 8100

# Terminal 2 — Express BFF (proxies /api/* from the web tier to the runner)
cd workbench/bff
npm install
npm run dev                                       # binds :3101

# Terminal 3 — Vite dev server (the UI)
cd workbench/web
npm install
npm run dev                                       # binds :5173

Or use the convenience Makefile:

cd workbench
make install                                      # npm install in bff + web
make backend                                      # pane 1 — :8100
make bff                                          # pane 2 — :3101
make web                                          # pane 3 — :5173

make install also runs npx playwright install chromium for the end-to-end test suite in workbench/e2e/. The make backend target is the workbench runner — distinct from make backend-research and make backend-finance, which spin up the A2A mesh demo peers for notebook 28, not the workbench.

Verify it's up

curl -s http://127.0.0.1:8100/api/health | jq        # runner
curl -s http://127.0.0.1:3101/api/health | jq        # bff
curl -sI http://127.0.0.1:5173/ | head -1            # web → HTTP/1.1 200 OK

Then open http://localhost:5173. Click Provider settings (top right), pick your provider, fill the credentials, hit Save. Pick a notebook from the sidebar, hit Run.

Run it in Docker

The packaged path. Best for handing the workbench to a teammate, a new laptop, or a demo machine where you don't want to install the Python and Node toolchains directly.

Build

git clone https://github.com/oracle-samples/locus.git
cd locus
docker build -t locus-workbench -f workbench/Dockerfile .

Image is ~1.3 GB on first build (Oracle Linux 9-slim base + Python 3.12 + Node 20 + locus + workbench source). Subsequent builds hit the BuildKit layer cache.

Run

For OpenAI / Anthropic providers — paste the key into Provider settings once the UI is up. Nothing extra to pass to the container:

docker run --rm -p 5173:5173 -p 3101:3101 -p 8100:8100 locus-workbench
# open http://localhost:5173

For OCI providers (api-key or session token), the OCI SDK reads ~/.oci/config at runtime — and that config file contains an absolute key_file path on your host. The container has no such path by default, so the SDK reads the config but fails to load the key. The fix is to bind-mount your host's ~/.oci at the same path inside the container and set HOME so the SDK looks for the config in the mirrored location:

docker run --rm -p 5173:5173 -p 3101:3101 -p 8100:8100 \
  -v "$HOME/.oci:$HOME/.oci:ro" \
  -e "HOME=$HOME" \
  locus-workbench

Both pieces matter — the mount alone gets the config file readable but the key_file line points at a path that still doesn't resolve; the HOME env alone redirects the SDK to a path nothing is mounted at. Together they mirror your host layout into the container so every absolute reference inside config lines up.

The mount is read-only (:ro) — the workbench never writes to your OCI directory.

Port collisions

If 5173 / 3101 / 8100 are taken on the host (you have the local workbench running, for instance), remap them:

docker run --rm \
  -p 5273:5173 -p 3201:3101 -p 8200:8100 \
  locus-workbench
# then http://localhost:5273

The container ports stay 5173/3101/8100 — only the host-side port changes. The Vite dev server inside the container always listens on 5173; remapping doesn't break the BFF→backend or web→BFF wiring.

Stop with Ctrl-C; --rm removes the container on exit.

Provider settings

The header's Provider settings modal accepts four shapes:

  • OpenAI — paste sk-… + pick a model (defaults to gpt-5.5).
  • Anthropic — paste sk-ant-… + pick a model (defaults to claude-sonnet-4-6).
  • OCI session tokenprofile (e.g. MY_PROFILE) + compartment_id + region. Reads ~/.oci/config at runtime; needs a valid session token. Works on localhost out of the box; works in Docker when you bind-mount ~/.oci (see Run it in Docker).
  • OCI api-key — same shape, different OCI auth type. Same hosting requirements as OCI session token.

Settings live in the page's memory. Closing the tab discards them. Reopening the page = paste again. This is intentional: an API key sitting in localStorage on a shared computer is a leak waiting to happen.

What you can run

The catalog populates from the BFF's /api/notebooks endpoint (aliased to /api/notebooks for backwards compatibility), which walks examples/notebook_*.py. As of writing the workbench has 9 dedicated FastAPI pattern endpoints:

Pattern What it shows
Basic agent One-shot Q&A — hello world for the SDK
Agent + tools ReAct loop with add and reverse tools
Structured output output_schema=Verdict → typed Pydantic result
Orchestrator + specialists Coordinator dispatches to researcher + editor
Sequential composition Two agents chained: researcher → summariser
Map-reduce code review Fan-out to 3 reviewers, reduce findings
StateGraph critic loop Writer → Critic cycle with allow_cycles
Long-term memory Two-session demo — see below
Cognitive routing Rule-based vs LLM-picker selection — see below

The rest run as plain Python subprocesses against your provider — same behaviour as running the notebook from a terminal, just inside the workbench so you can watch streamed events instead of tailing stdout.

Notebook 30 (DeepAgent) ships a part5_datastores section that exercises create_deepagent(datastores={"medical": …}) against an in-memory RAGRetriever. The same auto-wiring backs the deep-research project examples — seven runnable demos that swap the in-memory store for Oracle Autonomous Database, OpenSearch, or OCI Object Storage. The workbench surfaces the in-memory variant in the sidebar; the multi-backend versions live as standalone project demos in examples/projects/deep-research/.

Long-term memory pattern

Pick Long-term memory in the sidebar and paste a prompt that reveals something about yourself — your role, a preference, a constraint. The workbench runs two back-to-back agent sessions:

Session 1 processes your prompt and runs LLM-backed extraction to identify durable facts worth keeping. Those facts are persisted to an in-memory store (scoped to the request; cleared between runs).

Session 2 is a fresh agent with no conversation history — only the injected [Long-term Memory] block. It answers "What do you know about me?" using only what was stored, demonstrating cross-session recall without passing any raw history.

Sample prompts that produce interesting memory extraction:

I'm a senior Python engineer working on a compliance-driven auth rewrite.
I prefer short answers and always want real database connections in tests —
no mocks. Can you explain JWT vs session tokens briefly?
I'm a data scientist focused on model evaluation. I work in Python and use
Oracle ADB for storage. The project deadline is end of Q2. What's a good
evaluation metric for imbalanced classification?

The reply shows three sections: the Session 1 answer, the extracted memories (key/content pairs), and the Session 2 recall — so you can see exactly what the model chose to remember and how it surfaced in a fresh context.

Cognitive routing pattern

Pick Cognitive routing in the sidebar and you'll see a Selection mode segmented control above the Run button:

  • Rule-based (default) — ProtocolRegistry.select() → deterministic _rank_key tuple comparison. Auditable, reproducible, free of model latency.
  • LLM picker (opt-in) — LLMProtocolPicker lets the model pick the protocol from the filtered candidate set. PolicyGate, capability binding, and the candidate filter all stay rule-based; only the disambiguation step moves to the model.

Hit Run and the workbench shows a chip with the dispatched protocol_id plus a method badge (rule_based / single_candidate / llm_picked / rule_based_fallback). When LLM-picker mode dispatched the run, the model's one-sentence rationale renders as a callout above the reply text — the same field the router.protocol.selected SSE event carries.

Sample prompts that exercise different protocols:

What does the locus router do in the context of this SDK?
→ direct_response
Compare swarm vs orchestrator patterns for open-ended research.
→ debate (LLM picker may differ from the rule-based ranker)
Diagnose the checkout API latency spike: pull metrics, list alerts,
correlate findings.
→ specialist_fanout

See notebook 34 for the full code path and concepts/router.md for the architectural details.

Cost

You pay $0 to run the workbench itself. All three tiers run locally — your laptop or your Docker daemon. The only thing you pay for is the model calls your notebooks make, and those go directly to your provider key (OpenAI / Anthropic) or your OCI tenancy. Oracle pays nothing.

Troubleshooting

  • Sidebar is empty — the BFF couldn't reach the backend. The runner takes 10–20 s to start; reload the page once you see Uvicorn running on http://0.0.0.0:8100 in the backend logs (or docker logs <container> for the Docker path).
  • "Provider settings: setup required" never goes away — you closed the modal without hitting Save. Reopen and click Save.
  • OCI auth says "no profile" or KeyError: 'tenancy' — the OCI SDK can't find ~/.oci/config. On localhost: verify ~/.oci/config exists and the [<your-profile>] section has tenancy, user, fingerprint, key_file. In Docker: you forgot the bind-mount and HOME env — see Run it in Docker for the exact command.
  • OCI auth says the key file is missing — your key_file line in ~/.oci/config is an absolute path. In Docker, that path has to resolve inside the container. The -v "$HOME/.oci:$HOME/.oci:ro" -e "HOME=$HOME" pair mirrors the host layout so absolute paths line up.
  • Notebook fails with "no parsed Pydantic" / empty output — your model is too small for structured output. Use gpt-5.5-2026-04-23, gpt-4o, or claude-sonnet-4-6 for the demos that use output_schema.
  • oracle_26ai_indb_embeddings returns 400 "In-DB ONNX model 'ALL_MINILM_L12_V2' is not loaded" — the pattern defaults to the canonical Oracle ONNX model name. If your ADB has the model loaded under a different name (ALLMINILM, etc.), set OCI_INDB_MODEL=<your-model-name> in the backend's environment before starting it. Verify what's loaded with SELECT model_name FROM user_mining_models WHERE mining_function = 'EMBEDDING';.