Skip to content

Latest commit

 

History

History
661 lines (501 loc) · 25.4 KB

File metadata and controls

661 lines (501 loc) · 25.4 KB

RFC: Agent Loop Effect Interpreter

Field Value
Status Accepted
Date 2026-08-08
Author LoopX maintainers
Scope Public control-plane docs, packet contracts, refactor direction, test strategy

Summary

LoopX harness should be explained, designed, and tested as the effectful program around an agent loop, not as a collection of disconnected state machines.

The canonical shape is:

model -> effect request -> harness interprets effect -> observation -> model

The agent loop is the loop. The harness is the effectful program that interprets each effect request and returns an observation to the next model step.

The framing builds on the public lecture series by 齐梦星空: 主线一:Agent Loop 是 effectful program(1), 主线一:Tool Calling 是 Kleisli arrow(2) and 主线一:Agent Loop 里的小魔法:函数的组合(3).

LoopX's job is the middle two steps: it receives an effect request from an agent or host, decides whether and how to interpret it, writes back an observation, and returns control to the next loop iteration.

This RFC establishes the mental model, defines canonical packet semantics, and gives a milestone plan for aligning documentation, code, and tests with that model over time.

Milestone Status

Milestone Status
M0 RFC and Lecture 0 Merged (#2905, #2906, #2908)
M1 Canonical packet example Merged (#2907, #2910)
M1.5 Composition lens Merged (#2911)
M2 Bounded context alignment Mostly complete (#2912-#2915, #2919, #2926, #2933)
M3 Focused test families Mostly complete (#2916-#2918, #2925, #2929)
M4 Architecture documentation Mostly complete (#2921, #2923, #2924)
M5 Steady-state review Mostly complete (#2922, #2931)
M6 General effect-program abstraction In progress; Q3 complete (#2963-#2965), Q4 in progress; quality gate pending (#2938-#2959)

Why This Matters

Today, LoopX has many correct but hard-to-explain pieces:

  • todo lifecycle and handoff state;
  • quota decision and spend state;
  • scheduler and heartbeat state;
  • capability gates and user gates;
  • vision, monitor, and replan state;
  • evidence and run history.

Each piece has a state machine. The difficulty is not that these state machines exist. It is that a reader cannot immediately see what effect each state machine interprets, what observation it produces, and how that observation returns to the next loop.

The agent-loop-as-effectful-program lens fixes this by asking the same question everywhere:

Who interprets this effect request, and what observation comes back?

Core Mental Model

Agent Loop

The underlying loop is:

model -> effect request -> harness interprets effect -> observation -> model

The model proposes the next action. The harness decides whether the action is allowed, how to execute it, how to handle failure, and how to encode the result for the next model step.

Effectful Program

A pure computation is:

A => B

An effectful computation is:

A => F[B]

F captures the external world: persistence, permissions, budgets, timing, notifications, scheduling, evidence, and failure.

LoopX harness is best understood as that F around a long-running agent loop:

GoalState => F[QuotaDecision]

Mapping LoopX Concepts

Article concept LoopX equivalent
Agent loop Every automation heartbeat, PR monitor, and sustained refactor turn
Effect request todo add, quota spend, refresh-state, notify, monitor poll, bind-agent-thread
Harness interprets effect quota should-run + interaction_contract + capability_gate + work_lane_contract + scheduler_hint
Observation Quota packet, run history, evidence log, state writeback
Middleware mount points User gate, capability bridge, scheduler ACK, cooldown, external evidence poll
A => B Idealized GoalState => GoalState
A => F[B] Real GoalState => F[QuotaDecision]

Canonical Packet Semantics

Every important control-plane packet should be explainable through four semantic slots:

  1. effect_request
  2. interpretation
  3. observation
  4. next_effect

Example for quota should-run:

{
  "effect_request": "agent proposes next bounded turn",
  "interpretation": {
    "route": "advancement_task",
    "capability_gate": "repair_bridge",
    "scheduler_hint": "active_work"
  },
  "observation": {
    "decision": "run",
    "recommended_action": "...",
    "state_writeback": "validated_progress"
  },
  "next_effect": "execute bounded turn, then refresh-state"
}

These slots should not be a second schema. They are a documentation and naming discipline over existing packet fields. A new packet may add an effect_interpretation envelope only when a real caller needs one canonical place to read all four slots.

Composition And Around Semantics

The canonical loop is one effectful step:

GoalState => F[QuotaDecision]

The public lecture series distinguishes three layers of composition:

Composition Shape LoopX counterpart
Function composition A => B, B => C Read model -> projection -> decision
Kleisli composition A => F[B], B => F[C] One bounded turn, host effect, validated writeback
Middleware composition (A => F[B]) => (A => F[B]) Around decisions in capability_gate, interaction_contract, work_lane_contract, scheduler_hint

LoopX does not expose a generic Python middleware registry. Its around semantics are declarative and packet-shaped.

Handler Is Data, Not a Callable

Runtime middleware receives a handler callable and decides whether to call it, call it once, retry, fallback, or short-circuit. LoopX cannot receive a model or host callable across context and session boundaries. Instead, the interpreter returns a next_effect in the packet: CLI actions, scheduler ACK, and failure hint. The host or the next automation turn invokes that data-encoded handler.

This keeps the power of around style while making the handler durable and replayable:

  • short-circuit: decision and effective_action can say skip, wait, monitor_quiet_skip, repair_bridge, or ask_owner without pretending the original effect ran;
  • rewrite: work_lane_contract can preempt ordinary advancement with a due monitor or Lark inbox, and capability_gate can rewrite the next effect to materialize the missing capability first;
  • settle: scheduler_hint.ack_hint and failure_hint tell the host how to commit success or failure, while unchanged_poll bounds repeated attempts.

Failure, cancellation, permission, and budget stay visible in typed packet fields instead of being swallowed by a catch-all wrapper:

Around layer Packet field Short-circuit examples Rewrite examples
Capability capability_gate ask_owner, repair_bridge, unsupported Repair todo and CLI actions for the missing capability
Interaction interaction_contract User channel action_required, mode Primary action, protocol action, next CLI actions
Work lane work_lane_contract Monitor or inbox preemption, must_attempt_work=false Selected lane, obligation, next_lane
Scheduler scheduler_hint Pause/delete heartbeat, no-spend quiet RRULE, cadence class, stateful backoff

The order of these around layers is a contract, not an implementation detail. Changing the order changes which gate is observed first, which monitor can preempt ordinary work, and whether an ACK is still expected after a failed host update. Such changes need parity fixtures and focused tests.

Review a LoopX around decision with the same questions the lecture asks of a middleware stack:

  1. Which effect request is being interpreted?
  2. Which around layer owns the decision, and what observation does it emit?
  3. Can it short-circuit without pretending the effect ran?
  4. Where is the data-encoded handler (next_effect)?
  5. Are failure, cancellation, permission, and budget structured or swallowed?
  6. Is the around-layer order explicit and tested?
  7. Does evidence, trace, and budget continuity survive the host effect through writeback, ACK, and spend?

CLI Is a Higher-Density Effect

A single tool call is ToolInput => F[ToolOutput]. A LoopX CLI packet is a higher-density effect: one command can carry permission, budget, parameter validation, external execution, failure semantics, scheduler ACK, and writeback in the same request. The model still only proposes effect requests; the harness interprets them into CLI actions.

If a vendor API later supports serial tool calls or interleaved reasoning, that does not change the LoopX shape. It becomes an execution mode inside the interpreter:

  • serial, parallel, and interleaved are execution strategies, not new state machines;
  • effect_request -> interpretation -> observation -> next_effect stays stable;
  • next_effect changes from one CLI command to an ordered effect program.

General Effect-Program Abstraction

The current EffectTurn lens is intentionally read-only and quota-specific. It gives LoopX a stable vocabulary, a canonical read model, and around semantics over one real packet. It is not yet a general effect-program abstraction.

Refactoring alone will not create that abstraction. It creates the bounded contexts where a shared abstraction can safely live. The two tracks are parallel and equally important:

  • refactor: keep each state family in its owning bounded context;
  • generalize: extract the shared effect shape only when real runtime callers need it.

What Exists Today

  • EffectRequest, EffectInterpretation, EffectObservation, EffectNext, and EffectTurn as canonical slots.
  • interpret_quota_should_run_packet as the first real interpreter.
  • interpret_turn_result_packet as the second real interpreter.
  • EffectNext.execution_mode for serial, parallel, and interleaved execution strategy.
  • EffectProgram and effect_program_from_ordered_steps as a read-only shape over existing guided_transaction.ordered_steps.
  • R1 replacement: bootstrap guided rendering reads ordered_steps through EffectProgram (#2955).
  • R2 replacement: turn executor resolves result kind through interpret_turn_result_packet (#2956).
  • R3 replacement: Codex CLI local scheduler commands are built through EffectProgram (#2957).
  • around semantics encoded in capability_gate, interaction_contract, work_lane_contract, and scheduler_hint.
  • focused tests and docs that pin the lens.

What Is Missing

  • A minimal interpreter protocol or composition helper used by runtime code, not only by tests.
  • A real host or turn-driver caller that executes an ordered effect program while preserving failure, cancellation, permission, and budget semantics.

R4 remains deferred until that real multi-step executor caller exists.

When To Generalize

Generalize only when at least two real callers need the same shape:

  1. a second packet interpreter, such as a turn-result or status packet interpreter;
  2. a host or turn-driver caller that executes an ordered effect program.

Before then, keep the abstraction as a documented lens and add tests that prove each packet maps losslessly. This avoids building a generic Effect framework that no runtime uses.

Replacement Status

R1, R2, and R3 are complete:

  • R1 bootstrap guided rendering through EffectProgram (#2955);
  • R2 turn executor result-kind resolution through interpret_turn_result_packet (#2956);
  • R3 Codex CLI scheduler command set through EffectProgram (#2957).

R4 remains pending and must not be implemented until a real multi-step host/turn-driver caller executes an ordered effect program.

Qualitative Change Plan

The current effect abstraction is a read lens plus three small runtime replacements. It is not yet a qualitative change. M6 must not be called mostly complete until all of the following are true:

  1. Hot modules shrink to bounded sizes:
    • loopx/quota.py below 2000 lines (currently 1043);
    • loopx/status.py below 2000 lines;
    • loopx/heartbeat_prompt.py below 1200 lines.
  2. loopx quota should-run builds through a bounded should_run decision module, and loopx.quota.build_quota_should_run becomes a thin compatibility wrapper.
  3. EffectTurn and EffectProgram are consumed by CLI quota, turn driver, and bootstrap construction, not only by tests and renderers.
  4. No effect abstraction remains test-only.
  5. Maintainability, import-graph, CLI output, and hot-path interface ratchets pass without new exceptions.
  6. Doubao/model-behavior shadow qualification covers changed agent-facing packets.

Phases:

  • Q1: Stop milestone claims; keep M6 in progress.
  • Q2: Characterize hot modules and capture parity fixtures for quota.py, status.py, and heartbeat_prompt.py.
  • Q3: Extract the quota should-run decision and packet builder into bounded modules. Done: should_run.py entry decision (#2963), should_run_prepare.py preparation chain (#2964), and should_run_packet.py route/packet assembly (#2965).
  • Q4: Extract status read models, collection, and presentation into bounded modules. In progress; course/RFC reading paths updated to the new quota bounded modules.
  • Q5: Extract heartbeat prompt builders into bounded modules.
  • Q6: Make CLI quota, turn driver, and bootstrap construction consume EffectTurn / EffectProgram.
  • Q7: Add quality gates and focused tests for each extraction.
  • Q8: Re-evaluate M6 only after the gates pass.

Replacement-First Rule

Every M6 code change must replace an existing real runtime call path, not add a parallel unused abstraction.

  • Before replacement: capture a parity fixture or smoke for the existing path.
  • Replace: make runtime read/write flow through EffectTurn / EffectProgram.
  • After: delete the old path, or keep a compatibility wrapper only when a real external import or persisted contract requires it.
  • Test-only additions do not count as M6 progress.

Example replacements:

  • bootstrap_command_pack should read ordered_steps through effect_program_from_ordered_steps before rendering or validation;
  • turn_driver/executor should derive result status and next phase through interpret_turn_result_packet before committing a receipt.

State Machine As Interpretation Table

Instead of teaching state machines as a list of enum values, teach each state machine as an interpretation table:

Input effect | Interpreter | Decision | Observation | Next effect

Example for monitor scheduling:

Monitor cadence or due horizon
  -> scheduler interpreter
  -> host RRULE / initial interval
  -> scheduler_hint packet
  -> next heartbeat or monitor poll

This preserves the existing state machines while making their purpose visible.

Milestones

M0: RFC and Lecture 0

Goal: Publish this RFC and add a lecture that tells the story before any state machine detail.

Steps:

  1. Merge this RFC.
  2. Add Lecture 0: Harness Is the Effectful Program to docs/development/control-plane-course/.
  3. Rewrite docs/product/core-control-plane/state-machine.md to include an interpretation-table section for each state family.
  4. Update docs/README.md and course navigation to point to the RFC.

Acceptance criteria:

  • A new contributor can explain LoopX in one paragraph using the canonical loop shape.
  • Every existing state machine doc links back to the interpretation-table pattern.
  • No runtime behavior changes.

M1: Canonical Packet Example

Goal: Pick quota should-run as the canonical example and make the four semantic slots visible in docs and smokes.

Steps:

  1. Add a public-safe documentation section describing the four slots for quota should-run (docs/reference/effect-interpreter-packet.md).
  2. Add a focused pytest or smoke that asserts the mapping from raw inputs to the canonical interpretation fields.
  3. Keep the existing payload fields unchanged.

Acceptance criteria:

  • A reader can trace one real packet from effect request to observation.
  • No CLI output budget regression.
  • No new runtime contract without a real caller.

M1.5: Composition Lens

Goal: Make the around semantics visible in the canonical packet lens.

Steps:

  1. Document the three composition layers and the data-encoded handler in this RFC and Lecture 1.
  2. Extend EffectTurn with next_effect so all four semantic slots are represented in code, not only in prose.
  3. Add a focused test proving a capability gate is a structured around decision: it short-circuits, rewrites the next effect, and keeps permission semantics visible.
  4. Cite the public Tool Calling and Function Composition sources in public docs. Never cite internal lecture material.

Acceptance criteria:

  • A reader can answer where next_effect is encoded for a real packet.
  • The code lens covers effect_request, interpretation, observation, and next_effect.
  • No runtime behavior changes.

M2: Bounded Context Alignment

Goal: Align existing refactors with the effect-interpreter boundary.

Steps:

  1. Continue splitting status.py, quota.py, and goal_frontier.py into read-model, projection, and decision modules.
  2. Name the boundaries in terms of the loop:
    • read model = current A (state);
    • projection = observation;
    • decision = effect interpreter.
  3. Keep re-export compatibility for existing public imports.
  4. Do not create a generic effect abstraction until at least two real callers need the same envelope.

Acceptance criteria:

  • Module names and docstrings make the effect-interpreter role explicit.
  • Public import compatibility tests remain green.
  • Maintainability and line-budget smokes remain green.

M3: Focused Test Families

Goal: Convert large control-plane smokes into focused pytest modules by effect family.

Steps:

  1. Create focused pytest modules for:
    • work-lane contract;
    • quota decision;
    • scheduler/monitor interpretation;
    • state-machine interpretation tables.
  2. Keep thin end-to-end smokes that prove the CLI still works.
  3. Add regression tests for failure, cancellation, gate, and observation writeback paths.

Acceptance criteria:

  • Each effect family has a focused pytest module.
  • No large smoke is deleted before its focused replacement passes.
  • Full public smoke suite stays green.

M4: Architecture Documentation

Goal: Update architecture and product docs to use the same story.

Steps:

  1. Reframe docs/architecture.md around the canonical loop.
  2. Update the control-plane course so each lecture references the same effect_request -> interpretation -> observation flow.
  3. Update README product language where it currently says "state machine" without explaining the interpretation role.

Acceptance criteria:

  • The public docs no longer present LoopX as a pile of unrelated state machines.
  • Technical readers can identify the loop boundary, effect request, interpreter, and observation in each documented workflow.

M5: Steady-State Review

Goal: Keep the RFC as a living contract.

Steps:

  1. Add a canary smoke or docs smoke that checks the canonical packet documentation exists.
  2. Review new state machines and packet fields against the four semantic slots.
  3. Update this RFC when a new effect family requires a new canonical slot.

Acceptance criteria:

  • The RFC is referenced by maintainer docs and course material.
  • New control-plane features state which effect they interpret.

M6: General Effect-Program Abstraction

Goal: Move from a quota-only read lens to a shared effect-program abstraction without speculative framework construction.

Steps:

  1. Add a second real interpreter, for example interpret_turn_result_packet or interpret_status_packet, with focused tests that prove EffectTurn is lossless for that family too.
  2. Extract a minimal EffectInterpreter protocol only when the second caller needs it. Do not add a registry or a generic composition framework yet.
  3. Add execution_mode to EffectNext and document serial / parallel / interleaved semantics with focused tests.
  4. Introduce a data-encoded ordered effect program shape and a real executor seam when a host or turn-driver caller can execute multiple steps. The first executor candidate is the guided bootstrap transaction, because guided_transaction.ordered_steps already form a real ordered effect program consumed by hosts; the turn driver can later reuse the same shape.
  5. Keep failure, cancellation, permission, and budget semantics structured across every interpreter. No catch-all wrapper.

Acceptance criteria:

  • At least two packet families produce EffectTurn.
  • Runtime code, not only tests, consumes the shared shape.
  • next_effect can express an ordered effect program with an explicit execution mode.
  • No generic Effect monad, registry, or middleware framework is added without a second runtime caller.

Test Strategy

Tests should be organized by effect family, not by source-file size:

effect_request -> interpretation -> observation -> next_effect

Each focused pytest module should cover:

  • positive routing;
  • gate and capability decisions;
  • failure and cancellation;
  • observation writeback;
  • compatibility of public imports.

Large smokes remain only as thin end-to-end checks.

Runtime Replacement Testing

For every runtime replacement:

  • focused pytest covers the new seam and parity with the old path;
  • a thin public smoke exercises the real CLI or host path;
  • CLI output budget regression stays green;
  • model-behavior / Doubao shadow qualification covers agent-facing packet changes;
  • canary premerge includes core-control-plane and canary-runner profiles.

Non-Goals

  • Do not merge all state machines into one giant enum.
  • Do not create a generic Effect abstraction without two real callers.
  • Do not count test-only lenses as M6 progress; every M6 change must replace a real runtime call path.
  • Do not mark M6 mostly complete while quota.py, status.py, or heartbeat_prompt.py remain oversized or while effect abstraction is test-only.
  • Do not treat the current EffectTurn lens as a general runtime abstraction until a second interpreter and a real executor caller exist.
  • Do not rewrite quota should-run for the sake of naming.
  • Do not remove existing public compatibility routes without a migration window.

Risks

  • Naming drift: we may use "effect" as decoration without changing semantics. Mitigation: every RFC milestone must produce a real doc or test change.
  • Over-abstraction: a generic effect envelope could become unused scaffolding. Mitigation: only add a shared envelope when a second caller needs it.
  • Decorative naming: docs say "effect program" while runtime still only passes CLI strings. Mitigation: M6 requires a second interpreter and a real runtime replacement before the RFC claims a general abstraction.
  • Test churn: converting large smokes too fast can reduce e2e confidence. Mitigation: keep thin e2e until focused tests cover the same behavior.

Open Questions

  • Should effect_interpretation be a first-class field in the hot quota packet, or only a documented lens?
  • Should each capability own an interpretation table, or should the tables stay in central docs?
  • When should a new state machine be considered a new effect family?
  • Which packet family should be the second real EffectTurn interpreter: turn result, status, or monitor poll?
  • At what point should next_effect stop being a flat CLI tuple and become an ordered effect program with execution_mode?
  • Confirm the guided bootstrap transaction as the first ordered-effect executor path; the turn driver can reuse the same shape later.
  • When should EffectProgram become runtime-owned rather than host-driven?

Success Metrics

  • A new technical reader can explain LoopX in one paragraph.
  • Each major control-plane packet can be traced through the four semantic slots.
  • Focused pytest coverage grows while large smoke files shrink.
  • Public docs and course material use the same loop vocabulary.
  • Existing CLI output budgets and public compatibility contracts remain green.

Conclusion

LoopX harness is not "a set of state machines". It is the effectful program and effect interpreter around a long-running agent loop. This RFC makes that story explicit and gives the refactor and test work a stable target.

References