Expand description
The world piece of the ontology: a harness’s operational home as one typed value.
The world 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 world codecs (
docs/ONTOLOGY.md§2.5, §3): a home folder ⇄ [World]. - 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
defaultprofile;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.
- Channel
Config - One platform’s configuration.
- Expiry
Policy - 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.
- Outbound
Content - What is delivered.
- Pending
Pairing - A pairing code waiting for an admin.
- Permission
Policy - How prompts are answered when no human is reachable (§4.6).
- Persona
Ref - The persona:
AGENTS.mdat the profile root, content hash first. - Posted
- The platform’s handle for what was sent.
- Profile
- One profile: a folder with
AGENTS.mdat its root. - Profile
Residue - What a profile carries that the model does not interpret.
- Repeat
- Hermes 0.21.0’s
repeat:{times: N | null, completed: M};nulltimes = forever. - Route
- One route.
- Route
Match - What a route matches; most specific wins.
- Webhook
Subscription - One subscription: the route is
/webhooks/<name>. - Worker
Spec - The worker specification (O-record; Hermes has no worker choice).
- World
- The whole home: the persisted half of
OrchestratorState(§2.1); the runtime half is never written and is not part of the wire.
Enums§
- Access
Policy - Per-platform policy.
- EnvValue
- A worker environment value: a literal, or a secret by reference.
- Expiry
Scope - Which conversations share one session (Hermes
group_sessions_per_user,thread_sessions_per_user). - Fire
Status - A fire’s status.
unknownis Hermes’s own word for a fire whose scheduler restarted under it;completed⇄succeededon the codec boundary andtimeoutwrites back asfailed. - Obligation
Source - Where an obligation came from.
- Obligation
State - Delivery state;
sentis Hermes’sdelivered. - Permission
Default - 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_foranswers.
Functions§
- resolve_
route - The profile a surface routes to, or
Nonefor 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 world value, with every record it contains
as a definition — what
supercode ontology schemaprints 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.