Skip to content

Commit 2e0898f

Browse files
committed
docs(vrs): add source-linked language index
1 parent 33d159b commit 2e0898f

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

docs/vrs/ontology.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# st2 language
2+
3+
This is a small disambiguation index, not a behavioral specification. Each
4+
canonical term links to the source that owns its meaning. Follow that source
5+
for behavior, lifecycle, ordering, and wire or file formats.
6+
7+
st2 inherits agent-authoring language from the
8+
[canonical Agent Spec](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L1-L14).
9+
Terms without an independent authority are deliberately absent.
10+
11+
## Canonical language
12+
13+
| Term | Conceptual meaning | Authority |
14+
| --- | --- | --- |
15+
| **agent** | The actor st2 models. | [Agent Spec overview](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L1-L10); [R10 agent-only identity](requirements.md#L80-L81) |
16+
| **agent declaration** | The authored KDL representation of one agent. | [Agent Spec discovery and declaration shape](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L16-L31); [R02 canonical KDL](requirements.md#L36-L38) |
17+
| **agent runtime** | A running instance of an agent declaration. | [declared runtime vision](vision.md#L16-L24); [`AgentSpec` runtime model](../../crates/agent-spec/src/spec.rs#L1-L13) |
18+
| **agent task** | A terminal-backed or terminal-free unit declared for an agent. | [Agent Spec task contract](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L103-L120); [`Task`](../../crates/agent-spec/src/spec.rs#L58-L72) |
19+
| **agent identity** | The bare `identity` value of an agent declaration. It is not a claim of fleet-wide uniqueness. | [`AgentSpec::identity`](../../crates/agent-spec/src/spec.rs#L23-L40); [Agent Spec identity rules](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L24-L31) |
20+
| **bus ID** | The host-qualified agent address `<host>.<identity>`. | [`AgentSpec::bus_id`](../../crates/agent-spec/src/spec.rs#L123-L128); [Agent Spec bus identity](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L29-L31) |
21+
| **catalog** | The selected folder containing agent declarations and catalog-backed state. | [Agent Spec catalog boundary](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L29-L34); [catalog selection](../../src/main.rs#L848-L907) |
22+
| **catalog root** | The filesystem path selected as the catalog for a command. | [catalog path resolution](../../src/main.rs#L848-L907) |
23+
| **root agent** | The agent assigned host-local health observation, recovery, and escalation. | [R04 root supervision](requirements.md#L41-L46); [vision](vision.md#L20-L23) |
24+
| **control plane** | The replaceable `st2 up` process that reconciles host-local work. | [R11 control-plane replacement safety](requirements.md#L64-L71); [`up_loop`](../../src/run.rs#L1079-L1111) |
25+
| **declared supervisor** | The agent reference carried by a declaration for supervisory routing. | [`AgentSpec::supervisor`](../../crates/agent-spec/src/spec.rs#L23-L40); [Agent Spec field](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L73-L90) |
26+
| **presence** | The agent-authored availability signal read from catalog-backed state. | [`status::State`](../../src/status.rs#L19-L40); [R08 catalog observability](requirements.md#L72-L78) |
27+
| **session state** | st2's runtime observation of whether a task record is alive. | [`reconcile::Session`](../../src/reconcile.rs#L18-L25) |
28+
| **reconciliation** | Comparing declared host-local work with observed runtime state to produce a plan. | [`reconcile`](../../src/reconcile.rs#L1-L10); [reconcile pass](../../src/run.rs#L736-L810) |
29+
| **materialization** | Rendering catalog-declared content into an agent workspace. | [`materialize_catalog`](../../src/materialize.rs#L700-L727) |
30+
| **message** | A durable addressed record in an agent inbox or archive. | [`message::Message`](../../src/message.rs#L1-L35) |
31+
| **DING** | The terminal notification that makes an agent aware of unread messages. | [DING module contract](../../src/ding/mod.rs#L1-L14) |
32+
33+
## Collision rules
34+
35+
- Qualify **root** as [root agent](requirements.md#L41-L46) or
36+
[catalog root](../../src/main.rs#L848-L907). Bare *root* does not identify
37+
which concept is meant.
38+
- Qualify **supervisor** as [control plane](requirements.md#L64-L71) or
39+
[declared supervisor](../../crates/agent-spec/src/spec.rs#L23-L40).
40+
- Use [presence](../../src/status.rs#L19-L40) for the agent-authored signal and
41+
[session state](../../src/reconcile.rs#L18-L25) for runtime liveness. Avoid
42+
bare *agent status* when either could be meant.
43+
- Use [agent identity](../../crates/agent-spec/src/spec.rs#L23-L40) for the bare
44+
value and [bus ID](../../crates/agent-spec/src/spec.rs#L123-L128) for the
45+
host-qualified address.
46+
- Use [message](../../src/message.rs#L1-L35) for the durable record and
47+
[DING](../../src/ding/mod.rs#L1-L14) for its terminal notification.
48+
49+
## Avoid
50+
51+
**seat** is not canonical st2 language. Choose by meaning: [agent](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L1-L10)
52+
for the actor, [agent declaration](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L16-L31)
53+
for the catalog entry, and [agent runtime](vision.md#L16-L24) for a running
54+
instance. For admission, use an already-authoritative admission term only if
55+
one exists; this index does not canonize one.
56+
57+
The rejected word remains visible as design leakage in
58+
[issue #52](https://github.com/compoundingtech/st2/issues/52),
59+
[draft PR #55](https://github.com/compoundingtech/st2/pull/55), and one
60+
[Agent Spec phrase](https://github.com/compoundingtech/evals/blob/78210568e47244d80de99c18d0eea2d6b641c18a/AGENT-SPEC.md#L422-L429).
61+
Those references are evidence of recurrence, not authorities for a new st2
62+
concept.

0 commit comments

Comments
 (0)