Skip to main content

Event catalog

Generated from packages/events/src/catalog/. Do not edit by hand — run npm run gen. Catalog version: 0.33.0. "Don't break plugins": frozen shapes change only via new event versions.

EventSinceVFires whenResponse formsAliases
service.agent.batch0.18.01Schedule a batch of tool calls. Each context.execute call retains permission checks and executes at most once.value, deny—
service.agent.clear0.18.01Clear the active conversation through an interceptable service.value, deny—
service.agent.compact0.18.01Request compaction through the shared context service.value, deny—
service.agent.run0.18.01Execute a prepared turn through a replaceable strategy. Return a TurnOutcome in {value}.value, deny—
service.agent.tools0.18.01Resolve the effective tool definitions before a turn. Only returned tools can be called.value, deny—
service.auth.status0.18.01Read the selected authentication implementation's status.value, deny—
service.context.compact0.18.01Replace conversation compaction using the public turn context.value, deny—
service.context.manage0.18.01Run a replaceable context-pressure strategy before a model step.value, deny—
service.context.prepare0.18.01Prepare user input and optional attachments without assuming repository references.value, deny—
service.session.append0.18.01Persist a session event through a replaceable journal implementation.value, deny—
workspace.changed0.19.01User-selected filesystem scope for this session. File entries grant only that file; directory entries grant descendants. Replayed on resume.——
service.agent.enqueue0.20.01Queue a deduplicated plugin-owned agent follow-up without waiting for a model response. Runs after the current turn, pauses after interrupt, and is revoked when the plugin unloads.value, deny—
service.background.jobs0.20.01Optional background-jobs plugin subscription management. Starting, reading output and cancelling shells remain guarded exec/exec_output/exec_kill operations.value, deny—
shell.completed0.20.01A host background shell closed. Metadata only: no command, environment or process output. Emitted once per process after output streams close.next—
service.shell.jobs0.20.01Inspect this session’s host-owned background shells without reading command output. An optional id selects one job.value, deny—
session.start0.1.01Once per loaded plugin before the first prompt, and again after that plugin reloads. Carries the session composition (the udev moment: the module sees the device).nextclassic.SessionStart
session.reload0.1.01Plugin set changed. In-memory plugin state is recreated; reload is a state-recovery point.next—
session.end0.1.01Session ends, or /clear, /resume, /branch runs.nextclassic.SessionEnd
session.compact0.1.01The conversation is about to be compacted.next, skip—
command.invoke0.25.01An explicitly registered immediate user command. Only its owning plugin handles it; no model prompt or view is implied.——
command.operation0.25.01An independently owned user command starts or settles, outside the model turn.——
prompt.submit0.1.01A prompt is submitted. Rewrite text/context via next(), or drop it.next, text, drop—
prompt.compose0.1.01The system prompt is being assembled. Respond with ordered sections.sections—
skill.prompt0.1.01A skill's text is expanded for the model.next, text—
tool.call0.1.01A tool is about to run. Return { result } to answer it, { deny } to refuse, or pass the (rewritten) event to next().next, deny, resultclassic.PreToolUse
tool.operation0.22.01A separately owned user tool operation starts or settles; it is not a model turn.——
tool.check0.1.01Pre-execution decision, after tool.call and rules. Resolves to the allow/ask/deny decision.next, decision—
tool.describe0.1.01Once per tool, when its description is first sent to the model.next, description—
turn.start0.1.01A turn begins.nextturn.started
turn.step0.1.01One request is about to go to the model. Async-generator hook: may yield intermediate values.nextturn.step.started
turn.complete0.1.01A turn ended. May show a line under the answer.next, textclassic.Stop, turn.completed
agent.offer0.1.01A subagent type is offered to the model.next, withhold—
agent.spawn0.1.01A subagent or teammate is about to start (or resume). May pick its model or deny.next, deny—
prompt.steer0.5.01A steering message is injected into the running turn (codex Tab semantics).next—
prompt.queued0.5.01A prompt arrived while the agent was busy; it will start when the turn ends.next—
assistant.text0.5.01One streamed assistant text delta. Renderers usually subscribe() instead; the chain event exists for plugins that log or rewrite.next, text—
tool.result0.5.01A tool call resolved (ok or error). Errors are values — the turn continues.next—
turn.failed0.5.01A turn ended in an error (model failure, stream error). Fail-operational: the session stays alive.next—
turn.interrupted0.5.01The user interrupted the turn. In-flight model stream and tools were aborted best-effort.next—
turn.usage0.5.01Token usage of a turn, cumulative across its model steps. Fires before turn.complete/failed so cost plugins can tally.next—
subagent.start0.5.01A subagent (fresh AgentCore, isolated transcript) started on a prompt.next—
subagent.complete0.5.01A subagent finished: ok with its final text, or failed with an error value (fail-operational).next—
context.compacted0.5.01The transcript was compacted: the middle was folded into a summary, system prompt and recent tail kept verbatim.next—
context.compacting0.9.01Before context compaction, allowing observers to save state.——
context.pressure0.11.01Current request context budget, model limit source and estimated occupancy.——
service.model.capabilities0.11.01Resolve effective context/output limits for the selected model. Replaceable by provider plugins.value, deny—
service.agent.instructions0.11.01Resolve replaceable base agent behavior and tool guidance before a turn.value—
service.agent.finish0.11.01Evaluate a proposed final answer; return complete or a concrete continuation instruction.value—
service.ui.configure0.7.01Replace this plugin's appearance contribution. Partial sections inherit defaults; null removes the contribution. User window placements remain authoritative.value—
service.storage.read0.9.01Read JSON in the calling plugin namespace; missing values return undefined.value—
service.storage.write0.9.01Atomically persist bounded JSON in the calling plugin namespace and selected scope.value—
service.storage.config0.9.01Read merged global/project/local plugin configuration.value—
project.changed0.9.01Files or Git state changed; consumers can invalidate and refresh project indexes.——
service.network.configure0.9.01Configure this application network client; preserves protocol and streams, never changes global process environment.value—
ui.visibility0.8.01Plugin surface attachment and visible viewport changed; lets producers suspend hidden animations.——
ui.reaction0.8.01Semantic activity signal for optional visual companions. Consumers must not change the operation being observed.——
service.ui.remove0.8.01Remove this plugin surface from all workspaces.value—
agent.activity0.8.01Metadata-only activity of a background agent, for optional UI observers; excludes prompts and tool arguments.——
service.ui.inputTarget0.8.01Label the current input destination. Routing remains owned by the plugin.value—
service.ui.view0.8.01Publish a semantic plugin view. Action rows receive ui.press on click; placement remains user controlled.value—
service.agent.tool0.8.01Run a user-invoked plugin tool through the normal permission and tool hook chain, without a model request.value—
service.ui.surface0.6.01Publish or update a plugin window with optional split/sidebar/inspector/status-bar placement hints; user rules control workspace, size and focus.value—
ui.render0.1.01A render site is about to be drawn. Return an element tree. Writing plugin state during render is forbidden.tree—
ui.press0.1.01A plugin UI action, including a declared UI command, was invoked.next—
ui.change0.16.01An editable semantic plugin view field changed; never submits a model prompt.next—
ui.focus0.1.01Focus is about to move to another pane/control.next—
ui.invalidate0.1.01Damage tracking: the plugin marks changed regions of its pane.——
service.fs.read0.2.01$.fs.read(path): read a workspace-confined file (max 1 MB).deny, value—
service.fs.write0.2.01$.fs.write(path, content): write a workspace-confined file (max 10 MB).deny, value—
service.exec.run0.3.01$.exec.run(cmd, args?, opts?): run a workspace-confined subprocess (default 30 s timeout).deny, value—
service.model.complete0.2.01$.model.complete(request): call the configured model provider.deny, value—
service.auth.login0.2.01$.auth.login(provider?): run the auth flow of the configured auth capability.deny, value—
service.ui.ask0.5.01$.ui.ask / the ask_user tool: ask the human a question (optionally with choices). Headless sessions deny (fail closed).deny, answer—
service.ui.questionnaire0.15.01Collect an atomic questionnaire with single/multiple choices and custom text; cancel or headless operation never manufactures answers.deny, value—
service.ui.notify0.2.01$.ui.notify(message, level?): post a transient status message.deny, value—
service.telemetry.log0.2.01$.telemetry.log(event, data?): structured log line.deny, value—
service.skills.load0.5.01Load a skill by name from the configured registry.deny, value—
service.project.query0.8.01Replaceable project navigation provider: files, text, symbols, definitions and graph relations. Symbolic results include resolution metadata.deny, value—
service.sandbox.run0.8.01Replaceable isolated code execution. Host-supplied functions are process-local callbacks receiving (args, AbortSignal); never inferred from generated code.deny, value—
service.permission.review0.8.01Optional risk review only after permissions require approval. A reviewer may allow this exact call or return to manual approval; explicit denies cannot be overridden.deny, value—
service.permission.invalidate0.30.01Discard turn-local refusal memory after an explicit review-policy change. Does not grant permission or cancel active approvals.value—
service.context.control0.8.01Snapshot or restore conversation context. Restore is restricted to interactive controls outside model execution.deny, value—
model.usage0.8.01Per-request usage including auxiliary calls. Provider counts are preferred; estimated=true explicitly marks a fallback used for budgeting.——
service.usage.quota0.8.01Read optional provider-reported account quota; unavailable is explicit, not estimated.deny, value—
context.restored0.8.01Conversation restored from a checkpoint; resets replay and renderer transcript.——
service.checkpoint.control0.8.01List, inspect and restore turn checkpoints through a replaceable provider.deny, value—
service.agent.control0.8.01Manage independent persisted agents and optional Git worktrees; messages run asynchronously with separate budgets.deny, value—
service.model.stream0.8.01Shared streaming provider gateway for agent turns, compaction and plugin model calls. Return an AsyncIterable of provider events.deny, value—
context.prepared0.8.01Final user content after project context and explicit file references have been expanded.——
assistant.metadata0.8.01Provider reasoning continuation metadata for faithful session replay.——
service.session.control0.8.01List, search, name, fork, archive or resume local sessions. Resume requires an interactive host.deny, value—
service.extension.control0.21.01Manage plugin installation and activation from user UI independently of model turns. Busy file mutations wait for explicit application at idle.deny, value—
service.marketplace.control0.21.01List, register, refresh or remove plugin marketplaces from user UI independently of model turns.deny, value—
service.session.store0.8.01Local session storage operations used by interactive session hosts.deny, value—
service.shell.exec0.5.01Core exec tool: run a shell command (session cwd, timeout, env). With background: true it returns immediately with a shell id and keeps running.deny, value—
service.shell.execOutput0.5.01Read a backgrounded shell's buffered output (BashOutput analog).deny, value—
service.shell.execKill0.5.01Terminate a backgrounded shell by id (KillShell analog).deny, value—
service.agent.spawn0.5.01Spawn a subagent: a fresh AgentCore (shared provider/permissions/plugins, isolated transcript) runs the prompt to completion and returns its final text. Core-resolved.deny, value—
service.agent.open0.26.01Explicit user control: create a persisted shared-workspace side conversation, or reopen an existing agent by id, and focus its own message editor. The main turn is unaffected.deny, value—
service.workflow.run0.11.01Replaceable persistent workflow lifecycle: start, inspect, pause, resume, retry or stop. Host permissions remain in each worker.deny, value—
service.todo.update0.5.01Core todo tool: replace (or read) this Core/dispatcher's task list.deny, value—
service.file.read0.5.01Core read tool: paginated file read with truncation note.deny, value—
service.file.readText0.5.01Internal: raw full-text read (undo pre-image). null when missing.deny, value—
service.file.write0.5.01Create or overwrite a file. Optional expectedHash checks the current bytes before writing. Null requires an absent destination.deny, value—
service.file.edit0.5.01Core edit tool: exact (or whitespace-normalized) text replacement.deny, value—

Domains​

  • service: service.agent.batch, service.agent.clear, service.agent.compact, service.agent.run, service.agent.tools, service.auth.status, service.context.compact, service.context.manage, service.context.prepare, service.session.append, service.agent.enqueue, service.background.jobs, service.shell.jobs, service.model.capabilities, service.agent.instructions, service.agent.finish, service.ui.configure, service.storage.read, service.storage.write, service.storage.config, service.network.configure, service.ui.remove, service.ui.inputTarget, service.ui.view, service.agent.tool, service.ui.surface, service.fs.read, service.fs.write, service.exec.run, service.model.complete, service.auth.login, service.ui.ask, service.ui.questionnaire, service.ui.notify, service.telemetry.log, service.skills.load, service.project.query, service.sandbox.run, service.permission.review, service.permission.invalidate, service.context.control, service.usage.quota, service.checkpoint.control, service.agent.control, service.model.stream, service.session.control, service.extension.control, service.marketplace.control, service.session.store, service.shell.exec, service.shell.execOutput, service.shell.execKill, service.agent.spawn, service.agent.open, service.workflow.run, service.todo.update, service.file.read, service.file.readText, service.file.write, service.file.edit
  • workspace: workspace.changed
  • shell: shell.completed
  • session: session.start, session.reload, session.end, session.compact
  • command: command.invoke, command.operation
  • prompt: prompt.submit, prompt.compose, prompt.steer, prompt.queued
  • skill: skill.prompt
  • tool: tool.call, tool.operation, tool.check, tool.describe, tool.result
  • turn: turn.start, turn.step, turn.complete, turn.failed, turn.interrupted, turn.usage
  • agent: agent.offer, agent.spawn, agent.activity
  • assistant: assistant.text, assistant.metadata
  • subagent: subagent.start, subagent.complete
  • context: context.compacted, context.compacting, context.pressure, context.restored, context.prepared
  • project: project.changed
  • ui: ui.visibility, ui.reaction, ui.render, ui.press, ui.change, ui.focus, ui.invalidate
  • model: model.usage