Crate awaken 

Compatibility package that re-exports the primary awaken umbrella crate.

New code should depend on the published awaken package directly. This package exists so existing awaken-agent users can move to the new release line without changing import paths.

Modules

agent

builder

Fluent builder API for constructing AgentRuntime.

context

Context management: compaction, summarization, truncation, and plugin state.

contract

engine

Engine layer: genai-backed LLM executor and type conversion.

execution

Tool execution concerns: executors.

ext_generative_ui

ext_mcp

Model Context Protocol (MCP) client integration for external tool servers.

ext_observability

LLM telemetry plugin aligned with OpenTelemetry GenAI Semantic Conventions.

ext_permission

Permission extension for the awaken agent framework.

ext_reminder

Reminder extension for the awaken agent framework.

ext_skills

Skill subsystem for awaken.

extensions

Bundled extensions for the awaken runtime.

loop_runner

Minimal sequential agent loop driven by state machines.

model

phase

plugins

policies

Stop condition policy system and built-in policies.

prelude

One-import convenience module for awaken.

registry

Registry traits, in-memory implementations, and agent resolution.

registry_spec

Serializable agent definition — pure data, no trait objects.

runtime

server

HTTP server layer for the awaken agent framework.

state

Combined state types from both the contract and runtime layers.

stores

Storage backend implementations for the awaken framework.

Structs

AgentRuntime

Top-level agent runtime. Manages runs across threads.

AgentRuntimeBuilder

Fluent API for constructing an AgentRuntime.

AgentSpec

Serializable agent definition referencing registries by ID.

AgentSpecPatch

Patch for built-in agent customization.

CancellationToken

A cooperative cancellation token.

CommitEvent

ConfigRecord

Wrapper carrying a spec plus provenance + lifecycle metadata.

ExecutionEnv

Per-run execution environment.

FailedScheduledActions

MockProviderProfile

Explicit mock provider wiring for tests and local development.

MutationBatch

A batch of state mutation operations.

NoConfigPatch

Empty patch for spec types that do not support field-level overrides.

PendingScheduledActions

PersistedState

PhaseContext

Execution context passed to phase hooks and action handlers.

PhaseRuntime

PluginDescriptor

PluginRegistrar

ProviderRemovalImpact

ProviderRemovalPreview

RecordMeta

Provenance + lifecycle metadata for a stored spec.

RedactedString

String wrapper whose Debug/Display implementations never reveal the underlying value, and whose buffer is zeroized on drop.

RegistryResourceRef

RegistryValidationError

ResolvedAgent

A fully resolved agent: all capabilities + plugin environment, ready to run.

RunRequest

Unified request for starting or resuming a run.

RuntimeRegistryUpdate

SerializableRegistryDiagnostic

Snapshot

StateCommand

A command that carries state mutations, scheduled actions, and effects.

StateKeyOptions

StateMap

StateStore

TypedEffect

Enums

BuildError

Error returned when the builder cannot construct the runtime.

ConfigRecordError

Error returned while decoding a ConfigRecord or applying its overrides.

ConfigValidationError

JsonValue

Represents any valid JSON value.

KeyScope

Lifetime scope for a state key.

MergeStrategy

Parallel merge strategy for a state key.

Phase

Lifecycle phase within an agent run.

ProviderRemovalPolicy

RecordSource

Who wrote this record into ConfigStore.

RegistryDiagnostic

RegistryDiagnosticSeverity

RegistryUpdateError

RuntimeError

Runtime-specific errors that wrap StateError and add variants for agent resolution and run management.

StateError

UnknownFieldPolicy

Unknown-field behavior for a serializable config surface.

UnknownKeyPolicy

Constants

AGENT_SPEC_PATCH_UNKNOWN_FIELD_POLICY

AGENT_SPEC_UNKNOWN_FIELD_POLICY

AgentSpec and AgentSpecPatch reject unknown fields.

DEFAULT_MAX_PHASE_ROUNDS

MODEL_BINDING_SPEC_UNKNOWN_FIELD_POLICY

PROVIDER_SPEC_UNKNOWN_FIELD_POLICY

ProviderSpec’s serde implementation is intentionally lenient for read-time compatibility, but config write/validate surfaces reject unknown fields so operators do not persist silently ignored provider settings.

Traits

AgentResolver

Resolves an agent by ID, producing a ready-to-execute config + environment.

CommitHook

ConfigRecordMerge

Spec types that can apply RecordMeta::user_overrides at read time.

EffectSpec

PhaseHook

Plugin

PluginConfigKey

Typed plugin configuration key.

ScheduledActionSpec

StateKey

ToolGateHook

TypedEffectHandler

TypedScheduledActionHandler

TypedTool

A strongly-typed tool trait that derives its descriptor schema from Args.

Functions

decode_config_record

Decode a value into ConfigRecord<T>, accepting either an envelope or a legacy bare spec. This does not validate RecordMeta::user_overrides.

diagnose_agent_spec

diagnose_registry_set

diagnose_registry_set_serializable

effective_config_record

Apply RecordMeta::user_overrides to the record’s base spec.

effective_visible_config_records

Decode visible records and return their effective specs.

generate_tool_schema

Generate a JSON Schema for T that is suitable for LLM tool calling.

merge_agent_spec

Apply a AgentSpecPatch on top of a base AgentSpec, producing the effective spec passed to the resolver.

preview_provider_removal

rebuild_agent_model_provider_registries

sanitize_for_llm

Sanitize a JSON Schema value in-place to be LLM-friendly.

validate_against_schema

Validate args against a JSON Schema, returning an error with joined messages on failure.

validate_agent_spec

Validate and decode an AgentSpec.

validate_agent_spec_patch

Validate and decode an AgentSpecPatch.

validate_config_record

Validate and decode a config record envelope, accepting legacy bare specs. RecordMeta::user_overrides must decode as the patch type for T.

validate_config_record_overrides

Validate RecordMeta::user_overrides for an already decoded record.

validate_model_binding_spec

Validate and decode a ModelBindingSpec for config write surfaces.

validate_provider_spec

Validate and decode a ProviderSpec for config write surfaces.