Skip to main content

fred-runtime

fred-runtime is the infrastructure and execution layer for Fred agent pods.
It wires platform services (databases, LLM routing, MCP, observability, security) into the execution engine defined by fred-sdk, and provides a ready-to-use FastAPI app factory so any agent pod is just a registry and a YAML file away from running.


Where fred-runtime fits

Fred follows a strict three-layer model:

fred-core          Pure utilities — model factories, embeddings, logging, KPI store
     │
fred-sdk           Execution engine + authoring surface (pip-installable, no infra)
     │              ReAct runtime, Graph runtime, agent contracts, tool abstractions
     │
fred-runtime       Platform adapters + pod factory (this package)
                    SQL checkpointer, MCP wiring, LLM routing, OpenAI-compat surface,
                    FastAPI app factory, observability, security middleware

Rule of thumb:

  • Write agent logic in fred-sdk.
  • Write infrastructure adapters (DB, MCP server, Keycloak, object store) in fred-runtime.
  • fred-sdk must stay importable on a bare laptop with no services running.

What's in the box

fred_runtime.app — Agent pod factory

The main entry point for building a Fred agent pod.

from fred_runtime.app import create_agent_app, load_agent_pod_config

config = load_agent_pod_config()          # reads ENV_FILE + CONFIG_FILE (configuration.yaml)
app    = create_agent_app(registry=REGISTRY, config=config)

create_agent_app returns a FastAPI application that exposes:

Method Path Description
POST {base_url}/agents/execute Single-turn execution — returns final JSON
POST {base_url}/agents/execute/stream Streaming SSE execution — yields RuntimeEvent objects
GET {base_url}/agents List registered agent IDs
GET {base_url}/agents/sessions List session IDs for a user
GET {base_url}/agents/sessions/{id}/messages Full conversation history for a session
GET /v1/models OpenAI model list (agent IDs as model names)
POST /v1/chat/completions OpenAI chat completions — works with Open WebUI, openai-python SDK, etc.

The OpenAI-compatible /v1 surface is enabled by default.
Set app.openai_compat: false in configuration.yaml to disable it for internal pods.

Multi-turn continuity and HITL (human-in-the-loop) are handled transparently through the SQL checkpointer. The session ID is the LangGraph thread_id.


fred_runtime.runtime_support — Infrastructure adapters

Module What it provides
sql_checkpointer Durable LangGraph checkpointer backed by SQLite (dev) or PostgreSQL (prod)
user_token_refresher Transparent Keycloak token refresh for long-lived agent sessions
request_context_helpers FastAPI dependency helpers for extracting user/session context

fred_runtime.model_routing — LLM routing

Multi-provider model resolution with per-agent tuning overrides.
Supports routing by agent ID, execution category, or explicit model name.
Providers: OpenAI, Azure OpenAI, Mistral, Ollama, and any LangChain-compatible backend.


fred_runtime.common — Knowledge Flow + MCP clients

HTTP clients that connect agent tools to the Fred platform services:

Client Connects to
kf_http_client Knowledge Flow REST API (generic)
kf_vectorsearch_client Vector search / retrieval
kf_markdown_media_client Document content (Markdown + media)
kf_workspace_client Workspace and library management
kf_fast_text_client FastText classification
mcp_runtime / mcp_toolkit MCP server lifecycle and tool injection
context_aware_tool Tool base class that propagates the runtime context (user, team, token)

fred_runtime.integrations — v2 runtime adapters

Small adapters that bridge the platform-agnostic fred-sdk contracts to real services available at runtime (chat model factory, checkpointer wiring, MCP discovery).


fred_runtime.client — Developer CLI (fred-agents-cli)

An interactive REPL and one-shot client for any Fred agent pod:

# Interactive mode — connects to http://127.0.0.1:8000/api/v1 by default
fred-agents-cli

# Set the current team scope inside the REPL
/team my-team

# Inspect runtime KPIs without Grafana
/kpi
/kpi tool_name=search

# One-shot
fred-agents-cli --agent my-agent "What is the status of cluster A?"

# Keycloak browser login
fred-agents-cli --login

# Start already scoped to one team
fred-agents-cli --team-id my-team

# Override the metrics endpoint used by /kpi
fred-agents-cli --metrics-url http://127.0.0.1:9115/metrics

The target pod URL is resolved from configuration.yaml automatically, or overridden with --base-url / FRED_AGENT_POD_URL.


Configuration

Every Fred pod uses the same two-file convention:

File Purpose
.env (path from ENV_FILE) Secrets: API keys, DB URLs, Keycloak credentials
configuration.yaml (path from CONFIG_FILE) App settings: port, base URL, LLM routing, observability, security

Minimal configuration.yaml for a local pod:

app:
  name: "My Agent Pod"
  base_url: "/myapp/v1"
  host: "0.0.0.0"
  port: 8010
  log_level: "info"
  limit_concurrency: 200
  metrics_address: "127.0.0.1"
  metrics_port: 9115
  kpi_process_metrics_interval_sec: 10

observability:
  tracer: logging
  metrics: prometheus

ai:
  knowledge_flow_url: "http://localhost:8111/knowledge-flow/v1"

Full schema: fred_runtime.app.config.AgentPodConfig.

When observability.metrics: prometheus is enabled, create_agent_app(...) starts a dedicated Prometheus exporter on app.metrics_address:app.metrics_port and restores the shared Fred KPI pipeline, including process and SQL pool KPIs.

Set app.limit_concurrency: null to disable Uvicorn connection limiting, or a positive integer to reject excess concurrent HTTP and WebSocket connections with 503 before application code runs.


Installation

# Core library (runtime adapters, CLI, model routing)
pip install fred-runtime

# With FastAPI pod factory
pip install fred-runtime[app]

fred-runtime depends on fred-sdk[agents], so an agent pod installs nothing else to get the authoring surface. A Knowledge Base pod installs fred-sdk[knowledge-base] instead and never needs fred-runtime.

Requires Python 3.12.


Building an agent pod

A minimal pod is three files:

main.py

from fred_runtime.app import create_agent_app, load_agent_pod_config
from myapp.registry import REGISTRY

config = load_agent_pod_config()
app = create_agent_app(registry=REGISTRY, config=config)

__main__.py

import uvicorn
from fred_runtime.app import load_agent_pod_config

def main():
    config = load_agent_pod_config()
    uvicorn.run(
        "myapp.main:app",
        host=config.app.host,
        port=config.app.port,
        limit_concurrency=config.app.limit_concurrency,
        reload=True,
    )

if __name__ == "__main__":
    main()

registry.py

from fred_sdk.contracts.models import ReActAgentDefinition

class MyAgent(ReActAgentDefinition):
    agent_id = "my-agent"
    ...

REGISTRY = {MyAgent.agent_id: MyAgent()}

See fred-samples for a working reference pod.


Package PyPI Role
fred-pod pypi Pod floor — configuration, identity, naming
fred-core pypi Pure utilities — logging, model factories, embeddings, portable observability
fred-sdk pypi Agent authoring — ReAct, Graph, tool contracts
fred-runtime pypi This package

License

Apache License 2.0.

Metadata

Release files for fred-runtime 4.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fred-runtime 4.1.0
File Size Uploaded
fred_runtime-4.1.0.tar.gz 687.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fred-runtime 4.1.0
File Interpreter ABI Platform
fred_runtime-4.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.2 MB

Release files / fred_runtime-4.1.0.tar.gz

Download URL fred_runtime-4.1.0.tar.gz
Size 687.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d41eed3a85dc3a3d41c465cea0fecb0ec27b20ddfcb89fe2b15daf256c42ed48
BLAKE2b-256 checksum
How to use checksums
423adb2fe87cca2c24031373b4a38666c1b9d40610b852c6a61ab63301d5cb7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / fred_runtime-4.1.0-py3-none-any.whl

Download URL fred_runtime-4.1.0-py3-none-any.whl
Size 494.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9e7c222829a0de6e15a19fe08a62a189b9263132242afa2d12304de84db66b1a
BLAKE2b-256 checksum
How to use checksums
d142e3b872c4bd2ed79e92d03031bc9a0f157e7b151aa65d739a2bfd993f2de5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

4.5.1

2 release files

4.5.0

2 release files

4.4.3

2 release files

4.4.2

2 release files

4.4.1

2 release files

4.4.0

2 release files

4.3.0

2 release files

This release

4.1.0 This release

2 release files

4.0.0

2 release files

3.5.2

2 release files

3.5.1

2 release files

3.5.0

2 release files

3.4.5

2 release files

3.4.4

2 release files

3.4.2

2 release files

3.4.1

2 release files

3.4.0

2 release files

3.3.7

2 release files

3.3.6

2 release files

3.3.5

2 release files

3.3.3

2 release files

3.3.2

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.1.1

2 release files

3.1.0

2 release files

2.0.11

2 release files

2.0.10

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page