openclaw - ✅(Solved) Fix [RFC] Agent events, run context, scheduler lifecycle, and heartbeat contributions [1 pull requests, 1 comments, 1 participants]

Official PRs (…)
ON THIS PAGE

Recommended Tools

×6

Utilities matched from this issue’s tags and category — try them while you read without losing context.

GitHub issue graph ai analysis

Paste a GitHub issue URL. We fetch that issue, discover linked issues from bodies/comments/timeline, collect linked pull requests, and produce a structured English report.

The report is written in English Markdown for sharing and archival.

Helpful · Quick feedback

Loading…
GitHub stats
openclaw/openclaw#71737Fetched 2026-04-26 05:09:02
View on GitHub
Comments
1
Participants
1
Timeline
2
Reactions
0
Participants
Timeline (top)
commented ×1cross-referenced ×1

Expose safe plugin subscriptions to agent events, namespaced run-scoped plugin context, session-scoped scheduler helpers, and heartbeat prompt contributions.

This is proposed SDK surface, not currently implemented API.

Root Cause

Plan Mode parity requires plan snapshot persistence, subagent tracking, run completion cleanup, scheduled nudges, and heartbeat prompt nudges. Plugins need stable helpers for those behaviors without raw event-bus access or manual cron cleanup.

The same primitive applies to telemetry exporters, memory indexers, CI/deploy monitors, incident/ticket bots, channel notification plugins, long-running job monitors, and subagent coordinators.

Fix Action

Fixed

PR fix notes

PR #71731: docs: add Plan Mode plugin host hook RFC

Description (problem / solution / changelog)

Summary

This PR is a maintainer RFC package for making Plan Mode a first-class bundled plugin without merging the large host patch from #71676.

  • Problem: #71676 proves Plan Mode behavior, but it embeds the feature across session state, gateway patching, agent turn preparation, pending injections, tool policy, commands, Control UI, agent events, scheduler/cron, heartbeat prompts, docs, QA, and channel flows.
  • Why it matters: maintainers prefer a plugin path. A plugin port cannot reach 100% parity unless OpenClaw first exposes generic host seams in the plugin SDK.
  • What changed: added an RFC packet, public index page, six issue-sized RFC threads, current-SDK gap research, reusable plugin matrices, a #71676 entry-point coverage map, and fixture-test expectations for a future implementation PR.
  • What did NOT change: this PR intentionally does not implement hooks, Plan Mode behavior, prompts, tools, UI cards, session fields, scheduler changes, or runtime SDK APIs.

RFC Status Warning

This is proposed SDK design, not implemented SDK reference. The docs now include explicit warning callouts, and the public page has been moved out of SDK reference into a dedicated Plugin design RFCs nav group.

RFC Decision Threads

  • #71732 — Plugin session extensions and patch actions
  • #71733 — Durable next-turn injections and agent turn preparation hooks
  • #71734 — Trusted tool policy stage and plugin tool metadata
  • #71735 — Scoped plugin commands, trusted command ownership, and continuation
  • #71736 — Control UI plugin contribution slots
  • #71737 — Agent events, run context, scheduler lifecycle, and heartbeat contributions

The issue bodies have been expanded so each thread includes: proposed/not-implemented status, current SDK surface, missing host seam, Plan Mode parity use, reusable non-Plan plugin examples, decisions needed, and fixture acceptance criteria.

RFC Contents

The full RFC packet covers:

  • current SDK research against existing hooks, using #71427 as the comparison bar
  • reusable SDK capability matrix across public SDK, trusted/bundled SDK, gateway protocol, UI descriptors, runner boundary, lifecycle cleanup, and fixture tests
  • plugin archetype matrix for approval workflows, deploy/release, budget guards, memory/context, review/CI, incidents/tickets, channel integrations, workspace policy, telemetry/exporters, and long-running jobs
  • #71676 entry-point coverage map for Plan Mode parity
  • per-hook TypeScript-shaped API sketches
  • expected host files for each implementation slice
  • authorization, trust-tier, disablement, cleanup, and failure semantics
  • fixture-plugin acceptance tests for the future hook implementation PR
  • Plan Mode migration sequence and parity checklist

Change Type

  • Bug fix
  • Feature
  • Refactor required for the fix
  • Docs
  • Security hardening
  • Chore/infra

Scope

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

  • Related #71676
  • Related #71732
  • Related #71733
  • Related #71734
  • Related #71735
  • Related #71736
  • Related #71737
  • This PR fixes a bug or regression

Verification

Verified locally:

  • pnpm format:docs:check
  • pnpm lint:docs
  • pnpm docs:check-mdx
  • pnpm docs:check-links

Human Verification

  • Confirmed the docs nav no longer places the proposal under stable SDK reference.
  • Confirmed both docs pages warn that the named APIs are proposed, not implemented.
  • Confirmed the RFC packet includes a #71676 entry-point coverage map.
  • Confirmed all six live issue bodies are expanded beyond Plan Mode-only examples.
  • Did not run runtime Plan Mode behavior because this PR is docs/RFC-only and implements no hooks.

Compatibility / Migration

  • Backward compatible? Yes, docs-only.
  • Config/env changes? No.
  • Migration needed? No.

Risks and Mitigations

  • Risk: reviewers mistake the RFC for implemented SDK reference.
    • Mitigation: warning callouts plus Plugin design RFCs nav placement.
  • Risk: proposal appears Plan Mode-specific.
    • Mitigation: reusable SDK matrices, non-Plan plugin examples, and expanded issue bodies.
  • Risk: proposal overclaims parity.
    • Mitigation: #71676 entry-point coverage map and explicit note that actual parity requires the future hook implementation PR plus fixture tests.

Next Step After This PR

If maintainers accept the RFC direction, the next PR should implement the generic host hooks with a tiny fixture plugin. Only after that should Plan Mode itself move into a bundled plugin and be audited against #71676 for parity.

Changed files

  • docs/docs.json (modified, +4/-0)
  • docs/plan/plan-mode-plugin-host-hooks-rfc.md (added, +1289/-0)
  • docs/plugins/plan-mode-plugin-host-hooks.md (added, +492/-0)

Code Example

api.onAgentEvent("run_completed", handler);
ctx.runContext.set("plugin-key", value);
ctx.scheduler.createSessionJob({ pluginKey, sessionKey, kind, schedule, payload });
api.on("heartbeat_prompt_contribution", handler);
RAW_BUFFERClick to expand / collapse

Summary

Expose safe plugin subscriptions to agent events, namespaced run-scoped plugin context, session-scoped scheduler helpers, and heartbeat prompt contributions.

This is proposed SDK surface, not currently implemented API.

Why this matters

Plan Mode parity requires plan snapshot persistence, subagent tracking, run completion cleanup, scheduled nudges, and heartbeat prompt nudges. Plugins need stable helpers for those behaviors without raw event-bus access or manual cron cleanup.

The same primitive applies to telemetry exporters, memory indexers, CI/deploy monitors, incident/ticket bots, channel notification plugins, long-running job monitors, and subagent coordinators.

Current SDK surface

OpenClaw currently has runtime.events.onAgentEvent, internal AgentRunContext, hook contexts with run/session identifiers in some paths, gateway_start.getCron, generic prompt hooks, and heartbeat request helpers.

Those surfaces are useful but insufficient: raw event observation is not a typed lifecycle-owned plugin API; cron access does not provide plugin/session ownership cleanup; prompt hooks are not heartbeat-specific; and there is no namespaced plugin run-context storage that the host cleans on run completion.

Proposed solution

Add typed event subscription and lifecycle helpers such as:

api.onAgentEvent("run_completed", handler);
ctx.runContext.set("plugin-key", value);
ctx.scheduler.createSessionJob({ pluginKey, sessionKey, kind, schedule, payload });
api.on("heartbeat_prompt_contribution", handler);

The host should sanitize event payloads, enforce event access rules, own cleanup on run end/session reset/plugin disablement, and define deterministic heartbeat contribution ordering.

Reusable plugin examples

  • Plan Mode persists plan snapshots, tracks blocking subagents, schedules nudges, and contributes heartbeat reminders.
  • Telemetry exporters subscribe to sanitized events and batch scheduled exports.
  • Memory indexers observe run/tool events and refresh derived context.
  • CI watchers poll workflows and inject completion or failure summaries.
  • Incident bots schedule SLA escalations and heartbeat unresolved incidents.
  • Channel plugins track delivery events and retry failed sends.
  • Long-running job monitors poll job state, emit progress, and clean up on session close.
  • Subagent coordinators store per-run state and inject follow-up once subagents settle.

Decisions needed

  • Event types exposed to plugins and which require trust.
  • Run-context storage lifecycle and namespace model.
  • Session-scoped scheduler ownership and cleanup model.
  • Dedicated heartbeat hook vs heartbeat-scoped agent_turn_prepare.
  • Cleanup behavior on run end, cancellation, session reset/delete, gateway restart, and plugin disablement.
  • Diagnostics for dropped events, failed jobs, and suppressed heartbeat contributions.

Acceptance criteria

  • Fixture plugin observes one sanitized agent event.
  • Fixture plugin writes derived extension state from that event.
  • Run context data is available during a run and cleaned after completion/cancellation.
  • Session reset deletes fixture-owned scheduled jobs.
  • Plugin disablement removes fixture jobs and heartbeat contributions.
  • Heartbeat contribution appears only when fixture session state requests it.

References

extent analysis

TL;DR

Implement a namespaced plugin context and session-scoped scheduler helpers to expose safe plugin subscriptions to agent events and heartbeat prompt contributions.

Guidance

  • Review the proposed SDK surface and ensure it meets the requirements for plan mode parity, including plan snapshot persistence and scheduled nudges.
  • Determine the event types to be exposed to plugins and the trust requirements for each event type.
  • Define the lifecycle and namespace model for run-context storage and session-scoped scheduler ownership.
  • Implement cleanup behavior for run end, cancellation, session reset, gateway restart, and plugin disablement.

Example

api.onAgentEvent("run_completed", handler);
ctx.runContext.set("plugin-key", value);
ctx.scheduler.createSessionJob({ pluginKey, sessionKey, kind, schedule, payload });
api.on("heartbeat_prompt_contribution", handler);

Notes

The proposed solution requires careful consideration of event access rules, cleanup behavior, and deterministic heartbeat contribution ordering to ensure a stable and secure plugin API.

Recommendation

Apply the proposed solution to implement a namespaced plugin context and session-scoped scheduler helpers, as it provides a clear and structured approach to exposing safe plugin subscriptions to agent events and heartbeat prompt contributions.

Vote matrix · Quick signals

Works
Did the solution work? Tap to confirm.
Easy Fix
Was it a quick fix?
Time Saver
Did it save you time?
Blocking
Was it severely blocking?
Common Issue
Are others likely hitting this too?
Flaky / Intermittent
Is it intermittent?
Verified / Reproducible
Can you reproduce it reliably?
Loading…

Still need to ship something?

×6

Another batch ranked right after the header list — different links, same matching logic.

Back to top recommendations

TRENDING