Struct Instructions 

pub struct Instructions { /* private fields */ }

Optional root workspace instructions composed into the system prompt once.

Implementations

impl Instructions

pub fn discover(workspace: impl AsRef<Path>) -> Result<Self>

Loads AGENTS.override.md, falling back to AGENTS.md when absent.

Trait Implementations

impl Middleware for Instructions

fn name(&self) -> &'static str

Stable ID used to reject duplicate registrations.

fn prompt_fragment(&self, _runtime: &RuntimeContext) -> Result<Option<String>>

Contributes immutable system instructions once while the agent is created.

fn register( &self, _catalog: &mut Catalog, _runtime: &RuntimeContext, ) -> Result<()>

Adds tools to the catalog while the agent is created.

fn frontend(&self) -> FrontendContribution

Declares commands and status data that any frontend may render.

fn render(&self, _event: &EventMsg) -> Option<FrontendBlock>

Renders an event owned by this capability for thin frontend shells.

fn command<'a>( &'a self, context: MiddlewareCommandContext<'a>, ) -> BoxFuture<'a, Result<MiddlewareCommandOutput>>

Handles a command declared by this middleware’s frontend contribution.

fn initialize<'a>( &'a self, _context: RuntimeContext, ) -> BoxFuture<'a, Result<()>>

Restores middleware-owned durable state for this agent tree.

fn active_operations(&self) -> &'static [&'static str]

Declares active-turn operations owned by this middleware.

fn active_submission( &self, _context: &mut ActiveSubmissionContext<'_>, ) -> Result<ActiveSubmissionResult>

Handles one declared active-turn operation.

fn active_command( &self, _context: &mut ActiveCommandContext<'_>, ) -> Result<Option<ActiveSubmissionResult>>

Handles a capability command synchronously while a turn is active.

fn turn_ended(&self, _context: &mut TurnEndContext<'_>) -> Result<()>

Observes a turn ending and may clear capability-owned transient UI.

fn before_model<'a>( &'a self, _context: &'a mut ModelContext<'_>, ) -> BoxFuture<'a, Result<()>>

Mutates durable context before the next model request is assembled.

fn decorate_model_request<'a>( &'a self, _context: &'a mut ModelContext<'_>, ) -> BoxFuture<'a, Result<()>>

Applies request-only context after every durable transform has completed.

fn after_model<'a>( &'a self, _context: &'a mut AfterModelContext<'_>, ) -> BoxFuture<'a, Result<()>>

Observes one normalized response before it is checkpointed or dispatched.

fn shutdown<'a>( &'a self, _context: SessionEndContext, ) -> BoxFuture<'a, Result<()>>

Releases session-local state when the agent runtime stops.