# Jidoka v0.8.0-beta.1 - Table of Contents

> A data-driven agent framework for the Jido ecosystem with a Spark DSL and durable turn runtime.

## Pages

- [Jidoka](readme.md)
- [Changelog](changelog.md)
- [Contributing To Jidoka](contributing.md)
- [Jidoka Usage Rules](usage-rules.md)
- [LICENSE](license.md)

- Introduction
  - [Getting Started](getting-started.md)
  - [Core Concepts](core-concepts.md)
  - [Public Facade](public-facade.md)
  - [Configuration](configuration.md)

- Building Agents
  - [Agent DSL](agent-dsl.md)
  - [Tools And Operations](tools-and-operations.md)
  - [Structured Results](structured-results.md)
  - [Controls](controls.md)
  - [Memory](memory.md)
  - [Handoffs](handoffs.md)
  - [Import (JSON/YAML)](import-json-yaml.md)
  - [Inspection And Preflight](inspection-and-preflight.md)
  - [Testing And Evals](testing-and-evals.md)

- Operating Agents
  - [Runtime And Harness](runtime-and-harness.md)
  - [Sessions And Stores](sessions-and-stores.md)
  - [Snapshots And Resume](snapshots-and-resume.md)
  - [Human In The Loop](human-in-the-loop.md)
  - [Tracing And Events](tracing-and-events.md)
  - [Streaming](streaming.md)
  - [Agent View](agent-view.md)
  - [Idempotency And Safety](idempotency-and-safety.md)

- Integrations
  - [Live LLM Tool Loop](live-llm-tool-loop.md)
  - [Jido Process Integration](jido-process-integration.md)
  - [AshJido Resources](ash-jido.md)
  - [Browser Tools](browser-tools.md)
  - [MCP Tools](mcp-tools.md)
  - [Skill, Workflow, And Subagent Tools](skill-workflow-subagent-tools.md)
  - [Kino Notebooks](kino-notebooks.md)

- Reference
  - [Agent Spec Contract](agent-spec-contract.md)
  - [Turn And Effect Contracts](turn-and-effect-contracts.md)
  - [Operation Source Contracts](operation-source-contracts.md)
  - [Memory Contracts](memory-contracts.md)
  - [Import And Snapshot Contracts](import-and-snapshot-contracts.md)
  - [Errors And Config Reference](errors-and-config-reference.md)

- Internals
  - [Runic Spine Internals](runic-spine-internals.md)
  - [Turn Runner And Effect Interpreter](turn-runner-and-effect-interpreter.md)
  - [Runtime Capabilities Internals](runtime-capabilities-internals.md)
  - [Projection Internals](projection-internals.md)
  - [Contributor Testing](contributor-testing.md)

- Appendix
  - [Glossary](glossary.md)
  - [Troubleshooting](troubleshooting.md)

- Livebooks
  - [Jidoka Contracts And Runtime](01_contracts_and_runtime.md)
  - [Controls, Sessions, And Human Review](02_controls_sessions_and_human_review.md)
  - [Import, Eval, And Trace](03_import_eval_and_trace.md)

## Modules

- Main API
  - [Jidoka](Jidoka.md): Public facade for Jidoka.
  - [Jidoka.Action](Jidoka.Action.md): Minimal Jidoka wrapper around `Jido.Action`.
  - [Jidoka.Agent](Jidoka.Agent.md): Minimal Spark DSL for defining a Jidoka agent on top of Jido.
  - [Jidoka.AgentView](Jidoka.AgentView.md): Surface-neutral UI projection contract for a Jidoka agent.
  - [Jidoka.Control](Jidoka.Control.md): Minimal reusable policy control contract for Jidoka agents.
  - [Jidoka.Session](Jidoka.Session.md): Ergonomic session facade backed by `Jidoka.Harness.Session`.
  - [Jidoka.Stream](Jidoka.Stream.md): Request-scoped stream helpers for Jidoka turn events.

- Agent Data
  - [Jidoka.Agent.Message](Jidoka.Agent.Message.md): Durable chat message stored on agent state.
  - [Jidoka.Agent.Spec](Jidoka.Agent.Spec.md): Canonical immutable definition of a Jidoka agent.

  - [Jidoka.Agent.State](Jidoka.Agent.State.md): Durable semantic state for an agent session.
  - [Jidoka.Agent.Spec.Controls](Jidoka.Agent.Spec.Controls.md): Policy controls attached to a Jidoka agent definition.

  - [Jidoka.Agent.Spec.Controls.Input](Jidoka.Agent.Spec.Controls.Input.md): Control attached to the input boundary.

  - [Jidoka.Agent.Spec.Controls.Operation](Jidoka.Agent.Spec.Controls.Operation.md): Policy control attached to model-callable operations.

  - [Jidoka.Agent.Spec.Controls.Output](Jidoka.Agent.Spec.Controls.Output.md): Control attached to the final output boundary.

  - [Jidoka.Agent.Spec.Generation](Jidoka.Agent.Spec.Generation.md): Provider-facing generation defaults for an agent.
  - [Jidoka.Agent.Spec.Memory](Jidoka.Agent.Spec.Memory.md): Conversation memory policy for an agent.
  - [Jidoka.Agent.Spec.Operation](Jidoka.Agent.Spec.Operation.md): Model-callable operation definition.

  - [Jidoka.Agent.Spec.Result](Jidoka.Agent.Spec.Result.md): Structured app-facing result contract for an agent.

- Turns And Effects
  - [Jidoka.Event](Jidoka.Event.md): Core event emitted by Jidoka turn transitions.
  - [Jidoka.Usage](Jidoka.Usage.md): Token and cost usage helpers for Jidoka turns.
  - [Jidoka.Chat.Request](Jidoka.Chat.Request.md): Runtime handle for an async Jidoka chat request.
  - [Jidoka.Effect.Intent](Jidoka.Effect.Intent.md): Data description of an external effect the runtime may interpret.
  - [Jidoka.Effect.Journal](Jidoka.Effect.Journal.md): Intent/result journal used to make effects replayable.
  - [Jidoka.Effect.LLMDecision](Jidoka.Effect.LLMDecision.md): Typed model-side decision returned by an LLM effect.
  - [Jidoka.Effect.OperationRequest](Jidoka.Effect.OperationRequest.md): Typed request payload for an operation effect.
  - [Jidoka.Effect.OperationResult](Jidoka.Effect.OperationResult.md): Durable operation observation stored on agent state.
  - [Jidoka.Effect.Result](Jidoka.Effect.Result.md): Normalized result of an interpreted effect.
  - [Jidoka.Turn.Cursor](Jidoka.Turn.Cursor.md): Pointer to the next safe phase boundary.
  - [Jidoka.Turn.Plan](Jidoka.Turn.Plan.md): Executable data compiled from `Jidoka.Agent.Spec`.
  - [Jidoka.Turn.Request](Jidoka.Turn.Request.md): Input for one agent turn.
  - [Jidoka.Turn.Result](Jidoka.Turn.Result.md): Final app-facing result of one Jidoka turn.
  - [Jidoka.Turn.State](Jidoka.Turn.State.md): Ephemeral data value passed through the Jidoka turn workflow.
  - [Jidoka.Turn.Transition](Jidoka.Turn.Transition.md): Pure transition result for turn state changes.

- Sessions, Reviews, And Handoffs
  - [Jidoka.Handoff](Jidoka.Handoff.md): Data contract for conversation ownership transfer.
  - [Jidoka.Review](Jidoka.Review.md): Durable human-review data contracts.
  - [Jidoka.Handoff.OwnerStore](Jidoka.Handoff.OwnerStore.md): Storage boundary for conversation handoff owners.
  - [Jidoka.Handoff.OwnerStore.InMemory](Jidoka.Handoff.OwnerStore.InMemory.md): ETS-backed handoff owner store for local runtimes, examples, and tests.

  - [Jidoka.Harness.Session](Jidoka.Harness.Session.md): Serializable harness envelope for running an agent across requests.
  - [Jidoka.Harness.Store](Jidoka.Harness.Store.md): Behaviour and delegator for harness session storage.
  - [Jidoka.Harness.Store.InMemory](Jidoka.Harness.Store.InMemory.md): In-memory harness store for tests, examples, and local exploration.
  - [Jidoka.Review.Interrupt](Jidoka.Review.Interrupt.md): Durable pause point produced by a runtime control.
  - [Jidoka.Review.Request](Jidoka.Review.Request.md): Application-facing request for human review of an interrupted operation.

  - [Jidoka.Review.Response](Jidoka.Review.Response.md): Application response to a pending review request.
  - [Jidoka.Runtime.AgentSnapshot](Jidoka.Runtime.AgentSnapshot.md): Serializable semantic snapshot for hibernate/resume.

- Tools And Operation Sources
  - [Jidoka.Browser](Jidoka.Browser.md): Constrained browser tool source backed by `jido_browser` actions.
  - [Jidoka.Operation.Source](Jidoka.Operation.Source.md): Behaviour and compiler for operation sources.
  - [Jidoka.Skill](Jidoka.Skill.md): Jido.AI skill helpers used by the Jidoka DSL.
  - [Jidoka.Workflow](Jidoka.Workflow.md): Minimal deterministic workflow contract for Jidoka.
  - [Jidoka.Browser.Tools.ReadPage](Jidoka.Browser.Tools.ReadPage.md): Read a public HTTP(S) page through `jido_browser`.

  - [Jidoka.Browser.Tools.SearchWeb](Jidoka.Browser.Tools.SearchWeb.md): Search the public web through `jido_browser`.

  - [Jidoka.Browser.Tools.SnapshotUrl](Jidoka.Browser.Tools.SnapshotUrl.md): Return an LLM-friendly read-only page snapshot through `jido_browser`.

  - [Jidoka.Operation.Source.Handoff](Jidoka.Operation.Source.Handoff.md): Operation source for conversation handoff ownership.
  - [Jidoka.Operation.Source.Local](Jidoka.Operation.Source.Local.md): Local operation source backed by Elixir functions.
  - [Jidoka.Operation.Source.MCP](Jidoka.Operation.Source.MCP.md): Operation source backed by `jido_mcp`.
  - [Jidoka.Operation.Source.Subagent](Jidoka.Operation.Source.Subagent.md): Operation source for bounded subagent delegation.
  - [Jidoka.Operation.Source.Workflow](Jidoka.Operation.Source.Workflow.md): Operation source for deterministic Jidoka workflows.

- Import, Export, And Inspection
  - [Jidoka.Export](Jidoka.Export.md): Portable JSON/YAML export for `Jidoka.Agent.Spec`.
  - [Jidoka.Import](Jidoka.Import.md): JSON/YAML import runtime for data-authored Jidoka agents.
  - [Jidoka.Inspection](Jidoka.Inspection.md): Inspection and preflight helpers for Jidoka's data-first runtime.
  - [Jidoka.Projection](Jidoka.Projection.md): Stable public projections for Jidoka data contracts.
  - [Jidoka.Import.AgentDocument](Jidoka.Import.AgentDocument.md): Portable JSON/YAML authoring document for a Jidoka agent.
  - [Jidoka.Inspection.Preflight](Jidoka.Inspection.Preflight.md): Data returned by `Jidoka.preflight/3`.

- Memory, Trace, And Eval
  - [Jidoka.Eval](Jidoka.Eval.md): Small deterministic eval runner for Jidoka harness flows.
  - [Jidoka.Memory](Jidoka.Memory.md): Data contracts and runtime helpers for visible agent memory.

  - [Jidoka.Trace](Jidoka.Trace.md): Trace projection helpers for Jidoka runtime events.

  - [Jidoka.Eval.Case](Jidoka.Eval.Case.md): Deterministic evaluation case for one Jidoka turn.
  - [Jidoka.Eval.Run](Jidoka.Eval.Run.md): Result of running a `Jidoka.Eval.Case`.
  - [Jidoka.Memory.Entry](Jidoka.Memory.Entry.md): Durable memory entry available to prompt assembly.
  - [Jidoka.Memory.RecallRequest](Jidoka.Memory.RecallRequest.md): Request sent to a memory store before prompt assembly.
  - [Jidoka.Memory.RecallResult](Jidoka.Memory.RecallResult.md): Memory entries recalled for a turn.
  - [Jidoka.Memory.Store](Jidoka.Memory.Store.md): Behaviour and delegator for agent memory stores.

  - [Jidoka.Memory.Store.InMemory](Jidoka.Memory.Store.InMemory.md): In-memory memory store for deterministic tests and examples.

  - [Jidoka.Memory.Store.JidoMemory](Jidoka.Memory.Store.JidoMemory.md): `Jidoka.Memory.Store` adapter backed by `jido_memory`.
  - [Jidoka.Memory.WriteRequest](Jidoka.Memory.WriteRequest.md): Request to write one memory entry.
  - [Jidoka.Memory.WriteResult](Jidoka.Memory.WriteResult.md): Result returned after writing memory.
  - [Jidoka.Trace.Policy](Jidoka.Trace.Policy.md): Trace projection policy.
  - [Jidoka.Trace.Sink](Jidoka.Trace.Sink.md): Behaviour and delegator for trace sinks.
  - [Jidoka.Trace.Sink.InMemory](Jidoka.Trace.Sink.InMemory.md): In-process trace sink for tests, examples, and local inspection.

- Jido Integration
  - [Jidoka.Jido](Jidoka.Jido.md): Default Jido runtime instance for Jidoka agents.
  - [Jidoka.Runtime.Actions.RunTurn](Jidoka.Runtime.Actions.RunTurn.md): Jido action that runs one Jidoka turn inside `Jido.AgentServer`.
  - [Jidoka.Runtime.AgentServerState](Jidoka.Runtime.AgentServerState.md): Formal Jidoka state contract stored inside a process-hosted Jido agent.
  - [Jidoka.Runtime.Signals](Jidoka.Runtime.Signals.md): Signal constructors for the Jidoka/Jido AgentServer boundary.

- Livebook
  - [Jidoka.Kino](Jidoka.Kino.md): Optional Livebook helpers for inspecting and demonstrating Jidoka agents.

- Runtime Internals
  - [Jidoka.Harness](Jidoka.Harness.md): Thin execution harness around Jidoka's data-first agent kernel.
  - [Jidoka.Harness.Replay](Jidoka.Harness.Replay.md): Inspection-friendly replay projection for stored harness data.
  - [Jidoka.Runtime.Capabilities](Jidoka.Runtime.Capabilities.md): Runtime dependency bundle for interpreting effects.
  - [Jidoka.Runtime.Controls](Jidoka.Runtime.Controls.md): Runtime boundary for evaluating declared agent controls.
  - [Jidoka.Runtime.Controls.Operation](Jidoka.Runtime.Controls.Operation.md): Runtime evaluator for operation-scoped controls.

  - [Jidoka.Runtime.Controls.OperationContext](Jidoka.Runtime.Controls.OperationContext.md): Runtime context passed to controls at the operation boundary.
  - [Jidoka.Runtime.EffectInterpreter](Jidoka.Runtime.EffectInterpreter.md): Effect shell for the functional core.
  - [Jidoka.Runtime.JidoActions](Jidoka.Runtime.JidoActions.md): Runtime support for executing Jido actions as Jidoka operations.
  - [Jidoka.Runtime.LocalOperations](Jidoka.Runtime.LocalOperations.md): Runtime support for executing local Elixir functions as Jidoka operations.
  - [Jidoka.Runtime.ReqLLM](Jidoka.Runtime.ReqLLM.md): ReqLLM runtime support for Jidoka's LLM effect boundary.
  - [Jidoka.Runtime.ReqLLM.Decision](Jidoka.Runtime.ReqLLM.Decision.md): Parses the constrained JSON decision protocol used by the ReqLLM runtime.

  - [Jidoka.Runtime.Review](Jidoka.Runtime.Review.md): Runtime helpers for durable human review pauses.
  - [Jidoka.Runtime.TurnRunner](Jidoka.Runtime.TurnRunner.md): Executes one `Jidoka.Turn.Plan` through the Runic turn spine.
  - [Jidoka.Workflow.Compiler](Jidoka.Workflow.Compiler.md): Compiles `Jidoka.Turn.Plan` data into small Runic workflows.
  - [Jidoka.Workflow.Steps](Jidoka.Workflow.Steps.md): Pure phase functions used by the Runic turn workflow.

- Configuration And Errors
  - [Jidoka.Config](Jidoka.Config.md): Runtime configuration helpers for Jidoka.

  - [Jidoka.Error](Jidoka.Error.md): Splode-backed error helpers for Jidoka.
  - [Jidoka.Id](Jidoka.Id.md): Small boundary for generated Jidoka identifiers.
  - [Jidoka.Schema](Jidoka.Schema.md): Small Zoi helpers for Jidoka's data-first structs.

- Exceptions
  - [Jidoka.Error.Config](Jidoka.Error.Config.md): Configuration error class for Splode.
  - [Jidoka.Error.ConfigError](Jidoka.Error.ConfigError.md): Invalid Jidoka configuration error.
  - [Jidoka.Error.Execution](Jidoka.Error.Execution.md): Runtime execution error class for Splode.
  - [Jidoka.Error.ExecutionError](Jidoka.Error.ExecutionError.md): Jidoka runtime execution error.
  - [Jidoka.Error.Internal](Jidoka.Error.Internal.md): Internal error class for Splode.
  - [Jidoka.Error.Invalid](Jidoka.Error.Invalid.md): Invalid input error class for Splode.
  - [Jidoka.Error.ValidationError](Jidoka.Error.ValidationError.md): Invalid input or schema validation error.

