Module orchestration

Expand description

The orchestration piece of the ontology: a harness’s operational home as one typed value. The orchestration piece of the ontology (docs/ONTOLOGY.md §2.7, docs/ORCHESTRATOR-IR.md §2): a harness’s operational home as ONE typed value. These are the records the orchestrator loads, steps and saves; a Hermes or OpenClaw home compiles into them and decompiles back (the codecs are ONT-3’s). The wire form is the orchestrator IR’s canonical JSON: the runtime half is never persisted and is not here.

Modules§

access: Allowlists, admins and pairing (§2.4; Hermes gateway “Security & Access”).
channel: A channel: one platform block of config.yaml (§2.4). Credential values never enter the model; they are references.
codec: The orchestration codecs (docs/ONTOLOGY.md §2.5, §3): a home folder ⇄ [Orchestration].
fire: Fires: one execution of a job (§2.6; Hermes cron/executions.db).
job: Scheduled jobs (§2.6; Hermes cron/jobs.json).
obligation: Delivery obligations (§2.6; Hermes delivery_obligations).
profile: The home and its profiles (§2.1): the root folder IS the default profile; profiles/<name>/ are the named ones.
route: Routes: which profile answers a surface (§2.3, Hermes gateway.profile_routes).
subscription: Webhook subscriptions (§2.6; Hermes webhook_subscriptions.json).
worker: The worker: which harness runs a profile’s conversations, and how (§2.2).

Structs§

Access: The access record (access.yaml).
Attachment: Something attached to an outbound message.
ChannelConfig: One platform’s configuration.
ExpiryPolicy: When a conversation’s session ends on its own (docs/session-lifecycle.md).
Fire: One fire.
Job: One scheduled job.
JobOrigin: The conversation a job was created from (Hermes origin).
Obligation: One delivery obligation.
Orchestration: The whole home: the persisted half of OrchestratorState (§2.1); the runtime half is never written and is not part of the wire.
OutboundContent: What is delivered.
PendingPairing: A pairing code waiting for an admin.
PermissionPolicy: How prompts are answered when no human is reachable (§4.6).
PersonaRef: The persona: AGENTS.md at the profile root, content hash first.
Posted: The platform’s handle for what was sent.
Profile: One profile: a folder with AGENTS.md at its root.
ProfileResidue: What a profile carries that the model does not interpret.
Repeat: Hermes 0.21.0’s repeat: {times: N | null, completed: M}; null times = forever.
Route: One route.
RouteMatch: What a route matches; most specific wins.
WebhookSubscription: One subscription: the route is /webhooks/<name>.
WorkerSpec: The worker specification (O-record; Hermes has no worker choice).

Enums§

AccessPolicy: Per-platform policy.
EnvValue: A worker environment value: a literal, or a secret by reference.
ExpiryScope: Which conversations share one session (Hermes group_sessions_per_user, thread_sessions_per_user).
FireStatus: A fire’s status. unknown is Hermes’s own word for a fire whose scheduler restarted under it; completed ⇄ succeeded on the codec boundary and timeout writes back as failed.
ObligationSource: Where an obligation came from.
ObligationState: Delivery state; sent is Hermes’s delivered.
PermissionDefault: What happens to a worker’s permission prompt when no human answers.
Schedule: When a job fires.
Target: Where a result goes.

Constants§

RECORDS: Every name schema_for answers.

Functions§

resolve_route: The profile a surface routes to, or None for the adapter’s own profile. Ties are broken by declaration order, as Hermes does.
route_specificity: Most-specific-first: thread > chat > guild > platform.
schema: The JSON Schema of the whole orchestration value, with every record it contains as a definition — what supercode ontology schema prints and what the TypeScript types are generated from (ONT-6).
schema_for: The schema of one record by name, for readers who want a single type.