Skip to content

oracle-samples/locus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

291 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

locus — Multi-Agent SDK · pip install locus-sdk · Built by Oracle · github.com/oracle-samples/locus

Oracle Generative AI · Multi-Agent Reasoning Orchestrator SDK
Built inside Oracle. Used in production. Open to everyone.

PyPI version Python 3.11–3.14 License mypy strict ruff clean OCI GenAI day-0

OCI Generative AI · OpenAI · Anthropic · Ollama
Same Agent, same loop, same event stream — only the model id changes.

Documentation · Cognitive Router · Multi-agent · DeepAgent · 68 Notebooks · Workbench

Try every locus pattern in your browser → Workbench guide
Step-by-step setup for the browser playground — run it on localhost in three terminals, or in a single Docker container. Wire up an OCI profile, or bring your own OpenAI / Anthropic key.

Oracle 26ai is wired in as a first-class backend — native VECTOR(N, FLOAT32) RAG, durable agent threads, in-DB chunking and embeddings, all with zero LangChain dependency.


Your first agent — 5 lines

from locus.agent import Agent
agent = Agent(model="oci:openai.gpt-5")
print(agent.run_sync("What is the capital of France?").text)
# → Paris

That's it. Agent handles the model call, the response, and any retries. Swap "oci:openai.gpt-5" for "openai:gpt-4o" or "anthropic:claude-sonnet-4-6" — the interface stays the same.

Add a tool

Tools are plain Python functions. The model sees the docstring and decides when to call them.

from locus.agent import Agent
from locus.tools import tool
@tool
def get_weather(city: str) -> str:
    """Return the current weather for a city."""
    return weather_api.fetch(city)

agent = Agent(
    model="oci:openai.gpt-5",
    tools=[get_weather],
    system_prompt="You are a helpful travel assistant.",
)

print(agent.run_sync("Should I bring an umbrella to Tokyo tomorrow?").text)

The agent loops — Think → call tool → Think → answer — until it's done. Add @tool(idempotent=True) to any tool that must not fire twice (bookings, payments, alerts). The loop dedupes on (name, args) so retries are safe by design.

Install

pip install "locus-sdk[oci]"           # OCI GenAI (90+ models, day-0)
pip install "locus-sdk[openai]"        # OpenAI
pip install "locus-sdk[anthropic]"     # Anthropic
pip install "locus-sdk[sdk]"           # everything

No mandatory cloud account to start — MockModel lets every notebook run offline.

Quickstart guide


Talk to any provider

A model is a string. The prefix before the colon (oci:, openai:, anthropic:, ollama:) tells locus which provider to use; the rest is the model id that provider expects. get_model() parses the string and returns a ready client.

# tools, system_prompt, and every other kwarg are identical across providers
Agent(model="oci:openai.gpt-5.5")                # OCI → V1 transport
Agent(model="oci:cohere.command-r-plus")         # OCI → SDK transport (auto-routed)
Agent(model="oci:meta.llama-3.3-70b-instruct")   # OCI → V1
Agent(model="openai:gpt-4o")                     # OpenAI direct
Agent(model="anthropic:claude-sonnet-4-6")       # Anthropic direct
Agent(model="ollama:llama3.2")                   # local Ollama

The same Agent works against any provider — only the model id and the credentials change.

Provider Transport What it covers
OCI Generative AI V1 (OCIChatCompletionsModel) — default OpenAI commercial · Meta Llama · xAI Grok · Mistral · Google Gemini · Anthropic Claude on OCI
OCI Generative AI SDK (OCIModel) — auto for cohere.command-r* Cohere R-series native API
OCI Generative AI Responses (OCIResponsesModel) — opt-in Server-stateful endpoint for OpenAI / xAI / Gemini Responses-only models
OpenAI OpenAIModel Chat completions, reasoning models (o-series), base_url override for Azure · Portkey · LiteLLM · vLLM · together.ai · fireworks · groq
Anthropic AnthropicModel Claude family with prompt caching + extended thinking
Ollama OllamaModel Any local model (llama, mistral, qwen, deepseek-r1, …)
Custom register_provider("myco", MyModel) Implement BaseModelcomplete · stream · count_tokens (~50 lines)

Model providers concept page


The cognitive router (PRISM) — describe what you need, get the right shape

Once you know agents, the next step is knowing which shape to use. The cognitive router takes a natural-language task, fills a typed GoalFrame from an LLM extractor, deterministically picks one of eight built-in coordination protocols, and the CognitiveCompiler emits the matching runtime primitive (Agent, SequentialPipeline, ParallelPipeline, LoopAgent, an A2AClient call, or an approval-gated agent) — without you hand-coding the topology.

from locus.agent import Agent
from locus.router import (
    CapabilityIndex, CognitiveCompiler, GoalFrame, PolicyGate,
    ProtocolRegistry, Router, SkillIndex, builtin_protocols,
)
from locus.tools.registry import create_registry

# 1. Capabilities the router can bind to specialists.
registry = create_registry([kb_search, get_metric, list_alerts])

# 2. All 8 built-in protocols (answer / plan / specialist-fanout / debate
#    / codegen-loop / approval / a2a-delegate / handoff-chain).
protocols = ProtocolRegistry()
for p in builtin_protocols():
    protocols.register(p)

# 3. The Router wires an Agent(output_schema=GoalFrame) extractor + the
#    deterministic protocol picker + a CognitiveCompiler over the registry.
router = Router(
    frame_extractor=Agent(model=get_model(), output_schema=GoalFrame),
    protocols=protocols,
    capabilities=CapabilityIndex.from_registry(registry),
    skills=SkillIndex(),
    gate=PolicyGate(),
    compiler=CognitiveCompiler(),
)

# 4. Dispatch — the router picks the protocol + compiles the shape.
result = await router.dispatch(
    "We just got a sev-1 latency alert on the checkout service. "
    "Investigate and recommend remediation."
)
print(f"protocol={result.protocol_id} shape={result.runtime_shape}")
print(result.output)

The same router.dispatch(...) call resolves a one-shot lookup to a single Agent, a multi-step incident triage to a SequentialPipeline of planner→executor→validator, and a write-affecting action to an approval-gated agent — chosen by protocol selection, not by the model.

Protocol Compiled shape Best for
direct_response Single Agent ANSWER, EXPLAIN
plan_execute_validate SequentialPipeline (planner → executor → validator) PLAN, BUILD, MODIFY
specialist_fanout ParallelPipeline of N tool-bound Agents DIAGNOSE, MONITOR
debate Two debaters + judge Agent COMPARE
codegen_test_validate LoopAgent (stops on PASS) GENERATE_CODE
approval_gated_execution Agent wrapped in approval interrupt ESCALATE, REMEDIATE
handoff_chain SequentialPipeline of one-tool Agents COORDINATE
a2a_delegate Cross-process A2A call (opt-in) distributed meshes

Cognitive router concept · examples/notebook_58_cognitive_router.py


Eight orchestration shapes

When one agent isn't enough, locus gives you seven in-process shapes plus cross-process A2A. Every pattern uses the same Agent class and the same event stream.

Pattern When to use
SequentialPipeline A → B → C in order; each output feeds the next
ParallelPipeline Fan out to N agents simultaneously, merge results
LoopAgent Refine until a condition fires (PASS/FAIL, confidence, iteration cap)
Orchestrator + Specialists One coordinator routes to domain experts in parallel
Swarm Open-ended research; peers share a task queue and context
Handoff Escalation desk; conversation moves with full history to the next specialist
StateGraph Explicit DAG with conditional edges, cycles, and human-in-the-loop gates
A2A Cross-process meshes over HTTP; agents advertise capabilities via AgentCard
from locus.agent import Agent, SequentialPipeline
researcher = Agent(model=model, system_prompt="Find three key facts about the topic.")
critic     = Agent(model=model, system_prompt="Identify any gaps or errors in the research.")
writer     = Agent(model=model, system_prompt="Write a clear one-paragraph summary.")

result = await SequentialPipeline(agents=[researcher, critic, writer]).run(
    "Explain quantum entanglement to a high-schooler."
)
print(result.text)

All patterns


What you get

🧭 Cognitive router Describe a task → eight named protocols → right primitive compiled automatically. LLM fills a typed schema; routing is deterministic.
🤝 Multi-agent Seven native patterns + cross-process A2A. One Agent class. One event stream.
🔬 DeepAgent create_deepagent (single agent, per-turn grounding) and create_research_workflow (StateGraph with post-hoc grounding eval + two-level recovery).
📡 Observability Opt-in EventBus — one run_context() streams 40+ canonical events from every layer, no external broker. TelemetryHook for OpenTelemetry/OTLP.
🧠 Reasoning reflexion=True · grounding=True · CausalChain · GSAR typed grounding layer (arXiv:2604.23366).
🛡 Idempotent tools @tool(idempotent=True) — dedupes on (name, args). The model can't double-charge, double-book, or double-page.
💾 Durable memory 8 checkpoint backends — Oracle 26ai · OCI Object Storage · PostgreSQL · Redis · OpenSearch · in-memory · file · HTTP.
🧠 Long-term memory Oracle-native path: OracleAgentMemoryManager over Oracle's oracleagentmemory — LongMemEval-tuned recall, context cards, scoped retrieval. Portable path: LLMMemoryManager over any BaseStore (InMemory / Redis / Postgres / OpenSearch / Oracle).
🔎 RAG 4 vector stores — Oracle 26ai · OpenSearch · pgvector · in-memory. OCI Cohere + OpenAI embeddings · multimodal (PDF, image OCR, audio).
📡 Streaming + Server Typed events · SSE · AgentServer (FastAPI, per-principal thread isolation).
🪝 Hooks Logging · OpenTelemetry · ModelRetry · Guardrails · Steering (LLM-as-judge).
🪙 MCP MCPClient consumes MCP servers. LocusMCPServer exposes locus tools as MCP.
🌐 Multi-modal Agent(web_search=…, web_fetch=…, image_generator=…, speech_provider=…) auto-registers tools.
📊 Evaluation EvalCase / EvalRunner / EvalReport regression suites.
🧰 Models OCI GenAI (90+ models, V1 + SDK) · OpenAI · Anthropic · Ollama.

The agent loop

Every locus agent runs the same four-node loop — Think → Execute → Reflect → Terminate — with one immutable state flowing through.

Locus agent loop: Think → Execute → Reflect → Terminate

  • Think — model decides the next action or final answer.
  • Execute — runs tool calls in parallel; @tool(idempotent=True) dedupes on (name, args).
  • Reflect — Reflexion, Grounding, Causal on cadence or on error.
  • Terminate? — typed stop conditions: MaxIterations(10) | ToolCalled("submit") & ConfidenceMet(0.9).

Every node emits a write-protected typed event — same stream powers SSE, telemetry hooks, and your own async for event in agent.run(…) consumer.


Backed by Oracle Database 26ai

locus ships native primitives for Oracle Database 26ai — vector search, durable agent threads, in-database chunking and embeddings, and a long-term key/value store, all without a LangChain or LangGraph dependency. The contract is owned end-to-end inside locus.rag.stores and locus.memory.backends, and the same connection envelope (DSN + wallet) powers every primitive.

from locus.rag import OCIEmbeddings, OracleVectorStore, RAGRetriever

retriever = RAGRetriever(
    embedder=OCIEmbeddings(model_id="cohere.embed-english-v3.0"),
    store=OracleVectorStore(
        dsn="mydb_low",
        user="locus_app",
        password="…",
        wallet_location="~/.oci/wallets/mydb",
        dimension=1024,        # HNSW index by default
    ),
)
await retriever.add_documents(corpus)
hits = await retriever.retrieve("…", limit=5)

The seven primitives:

Primitive What it does
OracleVectorStore Native VECTOR(N, FLOAT32) column · VECTOR_DISTANCE SQL · HNSW / IVF / flat indexes · hybrid lexical + vector search · Mongo-style metadata filters · MMR re-rank.
oracle_checkpointer Single-row-per-thread durable agent state in Autonomous Database. Resume conversations across restarts, replicas, operator handoffs.
OracleCheckpointSaver LangGraph-shape versioned checkpoint history — every step preserved, with pending writes for intra-step durability.
OracleStore Cross-thread long-term memory: namespaced key/value with optional vector search inside a namespace (aput / aget / asearch aliases for langgraph-oracledb parity).
OracleADBLoader Stream rows out of any SELECT as Document objects (lazy or eager). Feed straight into a chunker, embedder, or retriever.
OracleInDBChunker Server-side text chunking via DBMS_VECTOR_CHAIN.UTL_TO_CHUNKS. Text never leaves the database.
OracleInDBEmbeddings In-database ONNX embeddings via DBMS_VECTOR_CHAIN.UTL_TO_EMBEDDING. Zero round-trips when the embedding model is loaded in the DB.

Zero langchain / langgraph dependency — the contracts live in locus, the SQL is generated locally, and the only runtime requirement is python-oracledb thin mode.

Notebook 06 — Oracle 26ai RAG · Notebook 07 — Oracle 26ai checkpointer · Notebooks 08-12 — loader, chunker, embeddings, store, versioned saver


68 notebooks

examples/ has 68 progressive notebooks, numbered in suggested reading order. Notebooks default to Oracle Cloud Infrastructure (OCI) Generative AI when an OCI profile is available, and fall back to a bundled mock model when one isn't — every example runs offline with no credentials needed.

Notebooks 06–12 land the Oracle 26ai primitives end-to-end: native VECTOR RAG, durable agent threads, the ADB document loader, in-DB chunking, in-DB embeddings, cross-thread long-term store, and the LangGraph-shape versioned checkpoint saver.

git clone https://github.com/oracle-samples/locus.git
cd locus && pip install -e .

python examples/notebook_01_oci_transports.py        # start here — three OCI transports
python examples/notebook_06_oracle_26ai_rag.py       # native VECTOR RAG on Oracle 26ai
python examples/notebook_07_oracle_26ai_checkpointer.py  # durable agent threads in ADB
python examples/notebook_14_basic_agent.py           # your first agent
python examples/notebook_35_deepagent.py             # deep-research factory
python examples/notebook_69_research_workflow.py     # full research pipeline
Track Range What you learn
OCI Generative AI 01–05 OCI transports, OCIChatCompletionsModel, Responses, Dedicated AI Cluster, Cohere Reranker V4
Oracle Database 26ai 06–12 Vector RAG, checkpointer, ADB loader, in-DB chunker, in-DB embeddings, cross-thread store, versioned saver
Agent Foundations 13–20 Agent, tools, memory, streaming, hooks, termination
Graphs & composition 21–28 StateGraph, conditional routing, reducers, HITL, composition, functional API
Multi-agent 29–39 Swarm, handoff, orchestrator, A2A, DeepAgent, debate, emergent routing
Reasoning & structured 40–42 Pydantic schemas, reasoning patterns, GSAR typed grounding
RAG 43–45 Basics, providers, RAG agents
Skills, playbooks, plugins 46–50 MCP, playbooks, plugins, skills, steering
Production 51–56 Guardrails, checkpoints, evaluation, providers, multi-modal
Cognitive router + observability 57–61 Routing, EventBus, yield bridge, event catalogue
Real-world workflows 62–66 Incident response, procurement, contract review, audio
Server & full pipelines 67–68 Agent server (FastAPI), full research workflow

Full notebooks index


Workbench

A browser-based playground for every locus pattern. Two clicks to a running agent — no CLI install, no editor setup. Three model slots (A / B / C) so multi-agent notebooks can mix a fast triage model with a deeper specialist. The Notebooks sidebar lists all 68 runnable notebook_*.py files, grouped by track, with live client-side filtering. A per-tab Provider Settings panel collects OCI / OpenAI / Anthropic credentials plus an optional Oracle 26ai database envelope that the Run handler forwards to the subprocess as ORACLE_* environment variables.

Two ways to run it. Pick whichever fits.

Run locally (from source)

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

# Three terminals, one per tier:
cd workbench/bff     && npm install && npm run dev   # BFF on :3101
cd workbench/web     && npm install && npm run dev   # Vite on :5173
cd workbench/backend && python -m uvicorn --app-dir . runner:app --port 8100

Open http://localhost:5173, click Provider settings, pick a provider, fill in the credentials, save. OCI options work out of the box because the backend reads your local ~/.oci/config.

Run in Docker

git clone https://github.com/oracle-samples/locus.git && cd locus
docker build -t locus-workbench -f workbench/Dockerfile .
docker run --rm -p 5173:5173 -p 3101:3101 -p 8100:8100 locus-workbench
# open http://localhost:5173

OpenAI and Anthropic work as-is — paste the key into Provider settings. For the OCI providers (api-key or session token), bind-mount your ~/.oci into the container at the same host path and pass HOME so the OCI SDK finds both the config and the key_file paths it references:

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

→ Full walkthrough: Workbench guide · Provider settings · Cognitive routing pattern · Troubleshooting


Deploy

pip install "locus-sdk[oci,server]"

AgentServer is a drop-in FastAPI app: POST /invoke, POST /stream, GET/DELETE /threads/{id}, GET /health.

from locus.server import AgentServer

server = AgentServer(agent=my_agent, api_key=os.environ["API_KEY"])
server.run(host="0.0.0.0", port=8080)

The repo ships a multi-stage Dockerfile ready to drop into your own image pipeline. Deploy anywhere FastAPI runs — OCI Functions, Container Instances, OKE, Compute, or any cloud equivalent.

Deploy guide


Repo layout

src/locus/
├── agent/          Agent runtime, config, SequentialPipeline / ParallelPipeline / LoopAgent
├── core/           AgentState, Message, events, termination algebra, Send
├── loop/           ReAct nodes (Think, Execute, Reflect)
├── router/         Cognitive router — GoalFrame, ProtocolRegistry, PolicyGate, CognitiveCompiler
├── deepagent/      create_deepagent + create_research_workflow + 6 node primitives
├── observability/  EventBus, run_context, agent yield bridge, EV_* constants
├── memory/         BaseCheckpointer + 9 backends
├── models/         Provider registry + OCI, OpenAI, Anthropic, Ollama
├── multiagent/     Orchestrator, Swarm, Handoff, StateGraph, Functional
├── a2a/            Cross-process Agent-to-Agent protocol
├── reasoning/      Reflexion, Grounding, Causal, GSAR
├── rag/            Embeddings + 7 vector stores + retrievers
├── providers/      Multi-modal: web search, web fetch, image, speech
├── tools/          @tool decorator, registry, builtins, executors
├── hooks/          Logging, telemetry, retry, guardrails, steering
├── skills/         AgentSkills.io filesystem-first capability disclosure
├── playbooks/      Declarative step plans + PlaybookEnforcer
├── server/         FastAPI AgentServer with thread persistence
├── evaluation/     EvalCase + EvalRunner + EvalReport
└── integrations/   MCP (client + server)

workbench/          Browser playground — Notebooks sidebar with live filter,
                    three model slots (A / B / C), per-tab Oracle 26ai
                    Database settings, SSE event stream, Docker-ready.
docs/               mkdocs Material site — concept pages, how-tos, notebook
                    catalog, API reference. Live filter on /notebooks/.
examples/           68 progressive notebooks, each a single runnable file.
                    notebook_NN_*.py — Oracle 26ai at 06–12, Agent
                    Foundations at 13–20, …
tests/unit/         Deterministic, no external deps. Runs in CI on every PR.
tests/integration/  Live OCI / OpenAI / Oracle Database 26ai. Gated on credentials.

Contributing

git clone https://github.com/oracle-samples/locus.git
cd locus && pip install -e ".[dev,all]"
hatch run check        # ruff + mypy
hatch run test         # unit tests across Python 3.11–3.14
pre-commit install

See CONTRIBUTING.md. Every PR runs format, lint, mypy, unit tests, DCO sign-off.


Citing GSAR

Paper: GSAR: Typed Grounding for Hallucination Detection and Recovery in Multi-Agent LLMs (PDF) — Federico A. Kamelhar, 2026.

@article{kamelhar2026gsar,
  title   = {GSAR: Typed Grounding for Hallucination Detection and Recovery in Multi-Agent LLMs},
  author  = {Kamelhar, Federico A.},
  journal = {arXiv preprint arXiv:2604.23366},
  year    = {2026},
  url     = {https://arxiv.org/abs/2604.23366},
}

Security

Please consult the security guide for our responsible security vulnerability disclosure process.


License

Copyright (c) 2026 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.

About

Oracle Generative AI Multi Agent Reasoning Orchestrator

Topics

Resources

License

UPL-1.0, UPL-1.0 licenses found

Licenses found

UPL-1.0
LICENSE
UPL-1.0
LICENSE.txt

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Generated from oracle/template-repo