# agent_db v0.1.0 - Table of Contents

> Embedded offline context store for AI agents

## Pages

- [AgentDb](readme.md)
- [LICENSE](license.md)
- [Quickstart (5 minutes)](quickstart.md)
- [Setup](setup.md)
- [Usage](usage.md)
- [Architecture](architecture.md)
- [Monitoring](monitoring.md)
- [API Reference](guide-api-reference.md)
- [Troubleshooting](troubleshooting.md)
- [Agent setup: OpenCode and Zed](agents.md)
- [Publishing to Hex](publishing.md)

## Modules

- [AgentDb.Application.DataTransfer.Manifest](AgentDb.Application.DataTransfer.Manifest.md): The on-the-wire shape of a transfer archive: its members, its manifest, and
the validation every entry must pass.
- [AgentDb.ML.BumblebeeLoader](AgentDb.ML.BumblebeeLoader.md): Loads models through Bumblebee and reports which serving runs them.
- [AgentDb.ML.ModelManager](AgentDb.ML.ModelManager.md): Manages embedding and LLM models for vector search and summarization.
- [AgentDb.ML.ModelManager.Backend](AgentDb.ML.ModelManager.Backend.md): Runtime that loads embedding and summarization models and runs inference.
- [AgentDb.ML.ModelManager.Backend.Emlx](AgentDb.ML.ModelManager.Backend.Emlx.md): Apple MLX backend (EMLX + EMLXAxon).
- [AgentDb.ML.ModelManager.Backend.Exla](AgentDb.ML.ModelManager.Backend.Exla.md): Bumblebee + EXLA backend (CPU by default, CUDA/ROCm when configured).
- [AgentDb.ML.ModelManager.State](AgentDb.ML.ModelManager.State.md): State struct for ModelManager
- [AgentDb.Mcp](AgentDb.Mcp.md): The MCP tool inventory over the store facade.
- [AgentDb.Observability.Sink](AgentDb.Observability.Sink.md): Holds the store's recent failures and outcome counts, so an operator can see
what has been going wrong without tailing a log.
- [AgentDb.Seed](AgentDb.Seed.md): Deterministic demo dataset for development and test environments.
- [AgentDb.Skills.Source](AgentDb.Skills.Source.md): Reading an Agent Skills bundle, and refusing one that cannot be stored as it is.
- [AgentDbWeb.Admin](AgentDbWeb.Admin.md): The shared behavior of a console page.
- [AgentDbWeb.Admin.DocumentsLive](AgentDbWeb.Admin.DocumentsLive.md): The console's documents page: what the store holds, one page at a time, and
how to find a document in it.
- [AgentDbWeb.Admin.MemoriesLive](AgentDbWeb.Admin.MemoriesLive.md): The console's memories page: what the store holds as memory.
- [AgentDbWeb.Admin.OverviewLive](AgentDbWeb.Admin.OverviewLive.md): The console's overview: what the store is doing right now.
- [AgentDbWeb.Admin.SessionsLive](AgentDbWeb.Admin.SessionsLive.md): The console's sessions page: looking a session up by id.
- [AgentDbWeb.Admin.SkillsLive](AgentDbWeb.Admin.SkillsLive.md): The console's skills page: importing Agent Skills into a user's subtree,
plus the installed-skill inventory.
- [AgentDbWeb.Admin.StorageLive](AgentDbWeb.Admin.StorageLive.md): The console's storage page: what the store holds and how much of it is cache
rather than content.
- [AgentDbWeb.AdminComponents](AgentDbWeb.AdminComponents.md): The console's sections, as function components.
- [AgentDbWeb.AuthPlug](AgentDbWeb.AuthPlug.md): Optional bearer-token authentication for the API.
- [AgentDbWeb.CORSPlug](AgentDbWeb.CORSPlug.md): CORS for the API.
- [AgentDbWeb.Channel](AgentDbWeb.Channel.md): The WebSocket surface.
- [AgentDbWeb.Context](AgentDbWeb.Context.md): The transport's view of the store.
- [AgentDbWeb.Controllers.DocumentController](AgentDbWeb.Controllers.DocumentController.md): Documents over HTTP.
- [AgentDbWeb.Controllers.HealthController](AgentDbWeb.Controllers.HealthController.md): Liveness, as the store reports it.
- [AgentDbWeb.Controllers.McpController](AgentDbWeb.Controllers.McpController.md): MCP Streamable HTTP endpoint.
- [AgentDbWeb.Controllers.ModelController](AgentDbWeb.Controllers.ModelController.md): What the store's models are doing, including a load in progress.
- [AgentDbWeb.Controllers.SearchController](AgentDbWeb.Controllers.SearchController.md): Search over HTTP.
- [AgentDbWeb.Controllers.SessionController](AgentDbWeb.Controllers.SessionController.md): Sessions over HTTP.

- [AgentDbWeb.DocumentEditorLive](AgentDbWeb.DocumentEditorLive.md): Editing one document.
- [AgentDbWeb.Endpoint](AgentDbWeb.Endpoint.md): The HTTP and WebSocket listener.
- [AgentDbWeb.Mcp](AgentDbWeb.Mcp.md): Compatibility shim over `AgentDb.Mcp`.
- [AgentDbWeb.Router](AgentDbWeb.Router.md): The HTTP surface.
- [AgentDbWeb.SessionAuth](AgentDbWeb.SessionAuth.md): Authentication for the browser surface.
- [AgentDbWeb.WebSocket](AgentDbWeb.WebSocket.md): The WebSocket endpoint.

- Context store
  - [AgentDb](AgentDb.md): Embedded offline context store for AI agents (OpenViking-inspired).
  - [AgentDb.Archive](AgentDb.Archive.md): A bounded tar archive, optionally gzipped, in both directions.
  - [AgentDb.Core.Storage](AgentDb.Core.Storage.md): Durable state the context store keeps, expressed without reference to any
particular database.
  - [AgentDb.Core.Transport](AgentDb.Core.Transport.md): An outer surface that exposes the store's public facade to a protocol.

- Inference and models
  - [AgentDb.Core.Inference](AgentDb.Core.Inference.md): The local model capabilities the store depends on.

- Background work and diagnostics
  - [AgentDb.JobQueue](AgentDb.JobQueue.md): The durable job queue: the SQL behind `AgentDb.Core.Storage`'s work
operations.
  - [AgentDb.Observability](AgentDb.Observability.md): Stateless runtime diagnostics: low-cardinality telemetry, distributed traces,
and redacted structured logs.

- HTTP, WebSocket and MCP
  - [AgentDbWeb](AgentDbWeb.md): The main web module for AgentDb.

## Mix Tasks

- [mix agent_db.abstract](Mix.Tasks.AgentDb.Abstract.md): Reads a document's L0 abstract -- the one-line answer to what this document is
about, for deciding whether to read the content at all.
- [mix agent_db.doctor](Mix.Tasks.AgentDb.Doctor.md): Checks store health and configuration.
- [mix agent_db.export_data](Mix.Tasks.AgentDb.ExportData.md): Exports store data to a tar archive.
- [mix agent_db.find](Mix.Tasks.AgentDb.Find.md): Discovers files and directories whose URI path contains `TERM`.
- [mix agent_db.grep](Mix.Tasks.AgentDb.Grep.md): Searches full document content (L2) for a literal substring.
- [mix agent_db.import_data](Mix.Tasks.AgentDb.ImportData.md): Imports store data from a tar archive.
- [mix agent_db.import_skills](Mix.Tasks.AgentDb.ImportSkills.md): Imports Agent Skills from the command line.
- [mix agent_db.index](Mix.Tasks.AgentDb.Index.md): Indexes Elixir sources structurally.
- [mix agent_db.overview](Mix.Tasks.AgentDb.Overview.md): Reads a document's L1 overview -- the bounded scan of its key points, for
deciding whether to read the content at all.
- [mix agent_db.read](Mix.Tasks.AgentDb.Read.md): Reads a document's full content (L2).
- [mix agent_db.recall](Mix.Tasks.AgentDb.Recall.md): Reads memories back, optionally scoped.
- [mix agent_db.search](Mix.Tasks.AgentDb.Search.md): Searches the context tree.
- [mix agent_db.seed](Mix.Tasks.AgentDb.Seed.md): Seeds a deterministic demo dataset for dev and test environments.
- [mix agent_db.tree](Mix.Tasks.AgentDb.Tree.md): Shows a depth-limited projection of the context tree.