riffer 0.31.0 → 0.32.0

data/lib/riffer/agent/run.rb

@@ -1,23 +1,10 @@
 # frozen_string_literal: true
 # rbs_inline: enabled
 
-# Riffer::Agent::Run is the generation loop. A pure module of functions over an
-# +agent+ — Agent owns every per-call value (provider, model, tools, tool
-# runtime, structured output, session, context); Run just orchestrates.
-#
-# Tools and user code see the agent's +context+ (a +Riffer::Agent::Context+)
-# unchanged through the loop, so downstream tool runtimes can read
-# caller-provided keys via <tt>context[:agent]</tt> /
-# <tt>context.dig(:key)</tt>, or the framework built-ins via
-# +context.skills+. Cumulative token usage is updated into
-# +agent.context.token_usage+ as the loop progresses.
-#
-#   Riffer::Agent::Run.generate(agent: my_agent, prompt: "Hello")
-#   Riffer::Agent::Run.stream(agent: my_agent, prompt: "Hello")
-#
+# The generation loop — a pure module of functions over an +agent+, which owns
+# every per-call value; Run just orchestrates.
 module Riffer::Agent::Run
   extend self
-  include Riffer::Messages::Converter
 
   # Runs the generate loop for the given agent. See Riffer::Agent#generate
   # for prompt/files semantics.
@@ -41,13 +28,6 @@ module Riffer::Agent::Run
 
   private
 
-  # The generation loop. When +stream_yielder+ is provided, per-step events are
-  # pushed to it (and +stream+ discards the return value). When +stream_yielder+
-  # is +nil+, no events are emitted and +generate+ returns the Response
-  # directly. The two modes share every step of the loop — the only
-  # divergences are the LLM call shape (atomic vs. accumulated stream)
-  # and whether per-step events are emitted.
-  #
   #--
   #: (Riffer::Agent, ?stream_yielder: Enumerator::Yielder?) -> Riffer::Agent::Response
   def run_loop(agent, stream_yielder: nil)
@@ -86,17 +66,12 @@ module Riffer::Agent::Run
       return final_response(agent, all_modifications)
     end
 
-    # catch returns the thrown value when throw :riffer_interrupt fires;
-    # the return above exits on the successful (non-interrupted) path.
     new_messages, filled = Riffer::Agent::Session::Repair.fill_orphans(agent.session.messages)
     agent.session.set(new_messages)
     stream_yielder << Riffer::StreamEvents::Interrupt.new(reason: reason, healed_tool_call_ids: filled) if stream_yielder
     final_response(agent, all_modifications, interrupted: true, interrupt_reason: reason, healed_tool_call_ids: filled)
   end
 
-  # Consumes one provider stream, forwarding every event to +stream_yielder+
-  # and folding it into an +Assistant+ message.
-  #
   #--
   #: (Riffer::Agent, Enumerator::Yielder) -> Riffer::Messages::Assistant
   def accumulate_streamed_response(agent, stream_yielder)
@@ -130,9 +105,6 @@ module Riffer::Agent::Run
     )
   end
 
-  # Appends +new_modifications+ to +all_modifications+ and emits a
-  # +GuardrailModification+ event for each one when streaming.
-  #
   #--
   #: (Enumerator::Yielder?, Array[Riffer::Guardrails::Modification], Array[Riffer::Guardrails::Modification]) -> void
   def record_modifications!(stream_yielder, all_modifications, new_modifications)
@@ -140,9 +112,6 @@ module Riffer::Agent::Run
     new_modifications.each { |m| stream_yielder << Riffer::StreamEvents::GuardrailModification.new(m) } if stream_yielder
   end
 
-  # Emits a +GuardrailTripwire+ event when streaming and returns the
-  # short-circuit +Response+ for a tripped guardrail.
-  #
   #--
   #: (Riffer::Agent, Enumerator::Yielder?, Riffer::Guardrails::Tripwire, Array[Riffer::Guardrails::Modification]) -> Riffer::Agent::Response
   def tripwire_response(agent, stream_yielder, tripwire, all_modifications)
@@ -150,11 +119,6 @@ module Riffer::Agent::Run
     build_response(agent, "", tripwire: tripwire, modifications: all_modifications)
   end
 
-  # Builds the final +Response+ from the session's last assistant
-  # message, validating structured output when configured. +extra+
-  # carries the interrupt-only fields (+interrupted:+, +interrupt_reason:+,
-  # +healed_tool_call_ids:+) on the interrupt exit path.
-  #
   #--
   #: (Riffer::Agent, Array[Riffer::Guardrails::Modification], **untyped) -> Riffer::Agent::Response
   def final_response(agent, all_modifications, **extra)
@@ -168,7 +132,7 @@ module Riffer::Agent::Run
     agent.provider.generate_text(
       messages: agent.session.messages,
       model: agent.model_name,
-      tools: agent.tools,
+      tools: effective_tools(agent),
       **merged_model_options(agent)
     )
   end
@@ -179,7 +143,7 @@ module Riffer::Agent::Run
     agent.provider.stream_text(
       messages: agent.session.messages,
       model: agent.model_name,
-      tools: agent.tools,
+      tools: effective_tools(agent),
       **merged_model_options(agent)
     )
   end
@@ -189,7 +153,9 @@ module Riffer::Agent::Run
   def execute_tool_calls(agent, assistant_message, tool_calls: assistant_message.tool_calls)
     return if tool_calls.empty?
 
-    results = agent.tool_runtime.execute(tool_calls, tools: agent.tools, context: agent.context, assistant_message: assistant_message)
+    results = agent.tool_runtime.execute(tool_calls, tools: effective_tools(agent), context: agent.context, assistant_message: assistant_message)
+
+    inject_discovered_tools(agent, results)
 
     results.each do |tool_call, result|
       agent.session.add(Riffer::Messages::Tool.new(
@@ -202,12 +168,17 @@ module Riffer::Agent::Run
     end
   end
 
-  # Executes tool calls left unfinished by a prior interrupt.
-  #
-  # Detects gaps between the last assistant message's requested tool calls
-  # and the tool result messages that follow it, executing any that are
-  # missing. Safe to call unconditionally.
-  #
+  #--
+  #: (Riffer::Agent, Array[[Riffer::Messages::Assistant::ToolCall, Riffer::Tools::Response]]) -> void
+  def inject_discovered_tools(agent, results)
+    to_inject = results.flat_map { |_, result|
+      result.is_a?(Riffer::Mcp::SearchTool::Result) ? result.discovered_tools : [] #: Array[singleton(Riffer::Tool)]
+    }
+    return if to_inject.empty?
+
+    agent.context.discover_tools(to_inject)
+  end
+
   #--
   #: (Riffer::Agent) -> void
   def execute_pending_tool_calls(agent)
@@ -215,11 +186,6 @@ module Riffer::Agent::Run
     execute_tool_calls(agent, assistant_message, tool_calls: pending) if assistant_message
   end
 
-  # Runs the +:before+ guardrail phase. Records any modifications into
-  # +all_modifications+ (and emits them when streaming). When a tripwire
-  # fires, yields the short-circuit +Response+ — the caller's block is
-  # expected to +return+ it from +run_loop+.
-  #
   #--
   #: (Riffer::Agent, Enumerator::Yielder?, Array[Riffer::Guardrails::Modification]) { (Riffer::Agent::Response) -> void } -> void
   def run_before_guardrails(agent, stream_yielder, all_modifications)
@@ -233,12 +199,6 @@ module Riffer::Agent::Run
     yield tripwire_response(agent, stream_yielder, tripwire, all_modifications) if tripwire
   end
 
-  # Runs the +:after+ guardrail phase against the assistant +response+.
-  # Records any modifications into +all_modifications+ (and emits them
-  # when streaming). When a tripwire fires, yields the short-circuit
-  # +Response+ — the caller's block is expected to +return+ it from
-  # +run_loop+. Otherwise returns the post-guardrails assistant message.
-  #
   #--
   #: (Riffer::Agent, Riffer::Messages::Assistant, Enumerator::Yielder?, Array[Riffer::Guardrails::Modification]) { (Riffer::Agent::Response) -> void } -> untyped
   def run_after_guardrails(agent, response, stream_yielder, all_modifications)
@@ -265,6 +225,13 @@ module Riffer::Agent::Run
     agent.structured_output.parse_and_validate(response.content).object
   end
 
+  #--
+  #: (Riffer::Agent) -> Array[singleton(Riffer::Tool)]
+  def effective_tools(agent)
+    discovered = agent.context.discovered_tools || []
+    discovered.empty? ? agent.tools : agent.tools + discovered
+  end
+
   #--
   #: (Riffer::Agent) -> Hash[Symbol, untyped]
   def merged_model_options(agent)
@@ -280,24 +247,18 @@ module Riffer::Agent::Run
     Riffer::Agent::Response.new(content, tripwire: tripwire, modifications: modifications, interrupted: interrupted, interrupt_reason: interrupt_reason, structured_output: structured_output, messages: messages.frozen? ? messages : messages.dup.freeze, healed_tool_call_ids: healed_tool_call_ids)
   end
 
-  # Appends a +User+ message to the session. No-ops when +prompt+ is nil
-  # and +files+ is empty (the caller had nothing to add). Raises when
-  # +files+ are supplied without a +prompt+ — the provider needs text to
-  # anchor the attachments.
-  #
+  # Raises when +files+ are supplied without a +prompt+ — the provider needs
+  # text to anchor the attachments.
   #--
   #: (Riffer::Agent, String?, ?files: Array[Hash[Symbol, untyped] | Riffer::Messages::FilePart]?) -> void
   def append_user_message(agent, prompt, files: nil)
     raise Riffer::ArgumentError, "files: requires a prompt" if files && !files.empty? && prompt.nil?
     return unless prompt
 
-    file_parts = (files || []).map { |f| convert_to_file_part(f) }
+    file_parts = (files || []).map { |f| Riffer::Messages::FilePart.from_hash(f) }
     agent.session.add(Riffer::Messages::User.new(prompt, files: file_parts), silent: true)
   end
 
-  # Accumulates token usage into +agent.context.token_usage+. Updates the
-  # context so cumulative usage persists across every run on the agent.
-  #
   #--
   #: (Riffer::Agent, Riffer::Providers::TokenUsage?) -> void
   def track_token_usage(agent, usage)

data/lib/riffer/agent/serializer.rb

@@ -3,37 +3,17 @@
 
 require "json"
 
-# Riffer::Agent::Serializer turns a resolved agent into a self-contained,
-# provider-neutral data hash and back into a runnable agent. A pure module
-# (sibling to Riffer::Agent::Run), reached most often through the
-# +Riffer::Agent#to_h+ / +Riffer::Agent.from_h+ delegators.
+# Turns a resolved agent into a self-contained, provider-neutral data hash and
+# back into a runnable agent, behind the +Riffer::Agent#to_h+ /
+# +Riffer::Agent.from_h+ delegators.
 #
-# The hash carries only data — no Procs, no class references, no tool
-# runtime. The same hash serves two rehydration targets:
-#
-# - <b>In-process</b> (a monolith persisting agent definitions): pass a
-#   +tool_resolver+ that looks tool descriptors up in a local registry and
-#   returns the real, body-bearing classes. They run on the default runtime.
-# - <b>Distributed</b> (a receiver holding only the Riffer gem): the default
-#   resolver synthesizes body-less tool shells; inject a remote
-#   +Riffer::Tools::Runtime+ to forward each call back to the origin.
-#
-#   data  = Riffer::Agent::Serializer.to_h(agent: agent)
-#   rebuilt = Riffer::Agent::Serializer.from_h(data, context: {tenant: "acme"})
-#
-# == What does not transfer
-#
-# Guardrails and the skills subsystem (backend/adapter/catalog) are not
-# serialized; a rebuilt agent enforces no guardrails and renders no skills
-# catalog (the +skill_activate+ tool, if present, crosses as an ordinary
-# tool). Secrets must not be placed in +provider_options+/+model_options+:
-# both ride on the wire as plain data.
+#   hash    = Riffer::Agent::Serializer.to_h(agent: agent)
+#   rebuilt = Riffer::Agent::Serializer.from_h(hash, context: {tenant: "acme"})
 module Riffer::Agent::Serializer
   extend self
 
-  # The wire format version. Bumped only on an incompatible change to the
-  # hash shape; +from_h+ refuses any other version. See +from_h+ for the
-  # dispatch seam that carries back-compat decoders.
+  # The wire format version, bumped only on an incompatible change to the hash
+  # shape; +from_h+ refuses any other version.
   SCHEMA_VERSION = 1 #: Integer
 
   # Raised by +from_h+ when the hash's +schema_version+ is unsupported.
@@ -43,16 +23,9 @@ module Riffer::Agent::Serializer
   # descriptor. Its +#call+ raises — route shells through a remote runtime.
   DEFAULT_TOOL_RESOLVER = ->(descriptor) { build_tool_shell(descriptor) } #: ^(Hash[Symbol, untyped]) -> singleton(Riffer::Tool)
 
-  # Snapshots a resolved agent into a self-contained wire hash.
-  #
-  # Reads the agent's resolved instance state — Proc-based settings have
-  # already been evaluated against the agent's own context, so the hash
-  # carries plain strings/data, never Procs. Tools are emitted as
-  # +{name, description, parameters_schema, timeout}+ descriptors (the
-  # resolved +agent.tools+, including MCP tools and +skill_activate+).
-  #
-  # [agent] a resolved Riffer::Agent instance.
-  #
+  # Snapshots a resolved agent into a self-contained wire hash. Proc-based
+  # settings are already evaluated against the agent's context, so the hash
+  # carries plain data, never Procs.
   #--
   #: (agent: Riffer::Agent) -> Hash[Symbol, untyped]
   def to_h(agent:)
@@ -71,35 +44,17 @@ module Riffer::Agent::Serializer
     }
   end
 
-  # Reconstructs a runnable agent from a wire hash.
-  #
-  # [hash] a Symbol-keyed wire hash (parse JSON with +symbolize_names: true+).
-  # [context] the rebuilt agent's runtime context — the same value you'd pass
-  #   to +Agent.new(context:)+. It is *not* used to re-resolve serialized
-  #   config (the hash is already resolved); it is threaded into tool dispatch
-  #   and read by tools/runtimes at call time (e.g. a remote runtime keying off
-  #   <tt>context[:tenant]</tt>). Defaults to an empty context.
-  # [session] an optional Riffer::Agent::Session to seed conversation history,
-  #   forwarded verbatim to +Agent.new(session:)+. The hash carries the agent
-  #   *definition*, not its history (see "What does not transfer"); pass a
-  #   session here to resume a persisted conversation. Used as-is — the caller
-  #   owns its contents, including the system instruction message. When omitted,
-  #   a fresh session seeded with the hash's instructions is built.
-  # [tool_resolver] maps a tool descriptor to a Riffer::Tool class. Defaults
-  #   to DEFAULT_TOOL_RESOLVER (body-less shells). Pass a registry lookup to
-  #   rebuild real, in-process tools.
-  # [tool_runtime] an optional Riffer::Tools::Runtime to inject (e.g. a
-  #   remote runtime for shells). When omitted, the agent uses the configured
-  #   default (+Riffer.config.tool_runtime+).
-  #
-  # Raises Riffer::Agent::Serializer::VersionError on an unsupported
-  # +schema_version+, and Riffer::ArgumentError on a malformed hash.
+  # Reconstructs a runnable agent from a wire hash. +context+ is threaded into
+  # tool dispatch (not used to re-resolve the already-resolved config);
+  # +session+ seeds conversation history (the hash carries the agent definition,
+  # not its history). Raises Riffer::Agent::Serializer::VersionError on an
+  # unsupported +schema_version+.
   #
   #--
   #: (Hash[Symbol, untyped], ?context: Hash[Symbol, untyped]?, ?session: Riffer::Agent::Session?, ?tool_resolver: ^(Hash[Symbol, untyped]) -> singleton(Riffer::Tool), ?tool_runtime: (singleton(Riffer::Tools::Runtime) | Riffer::Tools::Runtime | Proc)?) -> Riffer::Agent
   def from_h(hash, context: nil, session: nil, tool_resolver: DEFAULT_TOOL_RESOLVER, tool_runtime: nil)
     # Version -> decoder dispatch. Adding a +when 2+ arm (a backwards-compatible
-    # decoder) is how a future breaking change keeps older dicts readable.
+    # decoder) is how a future breaking change keeps older hashes readable.
     case hash[:schema_version]
     when SCHEMA_VERSION
       decode_v1(hash, context: context, session: session, tool_resolver: tool_resolver, tool_runtime: tool_runtime)
@@ -108,19 +63,15 @@ module Riffer::Agent::Serializer
     end
   end
 
-  # Snapshots a resolved agent to a JSON string. Convenience over
-  # <tt>JSON.generate(to_h(agent:))</tt>.
-  #
+  # Snapshots a resolved agent to a JSON string.
   #--
   #: (agent: Riffer::Agent) -> String
   def to_json(agent:)
     JSON.generate(to_h(agent: agent))
   end
 
-  # Reconstructs a runnable agent from a JSON string produced by +to_json+.
-  # Handles the JSON parse (with symbol keys) so callers don't have to. See
+  # Reconstructs a runnable agent from a JSON string produced by +to_json+. See
   # +from_h+ for the arguments.
-  #
   #--
   #: (String, ?context: Hash[Symbol, untyped]?, ?session: Riffer::Agent::Session?, ?tool_resolver: ^(Hash[Symbol, untyped]) -> singleton(Riffer::Tool), ?tool_runtime: (singleton(Riffer::Tools::Runtime) | Riffer::Tools::Runtime | Proc)?) -> Riffer::Agent
   def from_json(json, context: nil, session: nil, tool_resolver: DEFAULT_TOOL_RESOLVER, tool_runtime: nil)
@@ -162,20 +113,16 @@ module Riffer::Agent::Serializer
     Riffer::Params.from_json_schema(schema)
   end
 
-  # The DSL represents unlimited steps as +nil+, but the wire encodes it as
-  # +-1+ so the hash stays portable across transports where JSON +null+ is
-  # awkward (e.g. proto3, which can't tell null from an absent field). The
-  # magic value lives only on the wire — +encode_max_steps+/+decode_max_steps+
-  # translate at the boundary so neither the DSL nor consumers see it.
+  # Encodes unlimited steps (+nil+ in the DSL) as +-1+ on the wire, where a
+  # JSON +null+ is awkward across transports (e.g. proto3).
   #--
   #: (Numeric?) -> Numeric
   def encode_max_steps(value)
     value.nil? ? -1 : value
   end
 
-  # Reverses +encode_max_steps+: +-1+ (or a literal +null+) means unlimited.
-  # An absent key falls back to the default — a partial hash must not silently
-  # become an unbounded loop.
+  # Reverses +encode_max_steps+; a missing key falls back to the default so a
+  # partial hash can't become an unbounded loop.
   #--
   #: (Hash[Symbol, untyped]) -> Numeric?
   def decode_max_steps(hash)
@@ -189,12 +136,6 @@ module Riffer::Agent::Serializer
     tool_class.to_tool_schema(strict: false).merge(timeout: tool_class.timeout)
   end
 
-  # Builds an anonymous, body-less Riffer::Tool subclass that advertises the
-  # descriptor's schema to the LLM. Its +#call+ raises — a shell only has
-  # identity, not behavior; route its calls through a remote runtime.
-  #
-  # Returns +untyped+: steep can't see that +Class.new(Riffer::Tool)+ is a
-  # +singleton(Riffer::Tool)+ (cf. Riffer::Mcp::ToolFactory#build_tool_class).
   #--
   #: (Hash[Symbol, untyped]) -> untyped
   def build_tool_shell(descriptor)

data/lib/riffer/agent/session/repair.rb

@@ -1,39 +1,22 @@
 # frozen_string_literal: true
 # rbs_inline: enabled
 
-# Riffer::Agent::Session::Repair holds the pure transformations that keep the
-# +tool_use+ ↔ +tool_result+ invariant on a message array. No state, no
-# instance — module-level functions only. Each entry point is gated by
-# +Riffer.config.experimental_history_healing+: when the flag is off the
-# function returns its input unchanged.
-#
-# Two seams:
-#
-# - +fill_orphans+ — fills orphan +tool_use+ blocks with placeholder
-#   results. Used on interrupt (caller-issued or +max_steps+).
-# - +prune_orphans+ — drops orphan +tool_use+ blocks and parentless Tool
-#   messages from a caller-provided seed so it is well-formed before the
-#   next inference call. Used at construction time when
-#   +Riffer::Agent.new(session:)+ receives a session.
+# Pure, stateless transformations keeping the +tool_use+ ↔ +tool_result+
+# invariant on a message array. Each entry point no-ops when
+# +Riffer.config.experimental_history_healing+ is off.
 module Riffer::Agent::Session::Repair
-  # Placeholder used to fill orphan +tool_use+ blocks. Emitted as the
-  # +Riffer::Tools::Response+ body for each filled call_id.
+  extend self
+
+  # Placeholder response filled in for an orphaned +tool_use+ on interrupt.
   ORPHAN_PLACEHOLDER = ->(_tool_call) {
     Riffer::Tools::Response.error("Tool call interrupted before completion.", type: :interrupted)
   } #: ^(Riffer::Messages::Assistant::ToolCall) -> Riffer::Tools::Response
 
-  # Fills any orphaned +tool_use+ in +messages+ with the
-  # +ORPHAN_PLACEHOLDER+ response. Each placeholder Tool message is
-  # inserted immediately after its parent assistant message. Returns
-  # +[new_messages, filled_call_ids]+; +filled_call_ids+ is empty when
-  # there are no orphans.
-  #
-  # No-op when +Riffer.config.experimental_history_healing+ is off:
-  # returns +[messages, []]+ with the same array reference.
-  #
+  # Fills each orphaned +tool_use+ in +messages+ with an +ORPHAN_PLACEHOLDER+
+  # result inserted after its parent. Returns +[new_messages, filled_call_ids]+.
   #--
   #: (Array[Riffer::Messages::Base]) -> [Array[Riffer::Messages::Base], Array[String]]
-  def self.fill_orphans(messages)
+  def fill_orphans(messages)
     return [messages, []] unless Riffer.config.experimental_history_healing
 
     result_ids = messages.filter_map { |m| m.tool_call_id if m.is_a?(Riffer::Messages::Tool) }
@@ -62,22 +45,13 @@ module Riffer::Agent::Session::Repair
     [new_messages, filled]
   end
 
-  # Prunes a seeded message array so the +tool_use+ ↔ +tool_result+
-  # invariant holds. Drops orphaned tool exchanges (assistant +tool_call+
-  # with no matching Tool result) and parentless Tool messages. Returns a
-  # new array; the input is not mutated.
-  #
-  # Pending tool_calls on the resume boundary — the last assistant whose
-  # tail is purely Tool results (or empty) — are preserved. They get
-  # swept up by +execute_pending_tool_calls+ at the start of the next
-  # generate/stream call.
-  #
-  # No-op when +Riffer.config.experimental_history_healing+ is off:
-  # returns +messages+ unchanged.
-  #
+  # Prunes a seeded message array to the invariant — dropping orphaned tool
+  # exchanges and parentless Tool messages, but preserving the pending
+  # tool_calls on the resume boundary (the last assistant) for
+  # +execute_pending_tool_calls+. Returns a new array.
   #--
   #: (Array[Riffer::Messages::Base]) -> Array[Riffer::Messages::Base]
-  def self.prune_orphans(messages)
+  def prune_orphans(messages)
     return messages unless Riffer.config.experimental_history_healing
 
     resume_boundary = (messages.length - 1).downto(0).find { |idx|

data/lib/riffer/agent/session.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 # rbs_inline: enabled
 
-# Riffer::Agent::Session owns the conversation handle for an agent: the message
-# array, the +on_message+ callback list, and the +tool_use+ ↔ +tool_result+
-# invariant that keeps tool calls and their results consistent.
-#
-# Access via +agent.session+. Sessions are constructed by +Riffer::Agent+
-# and live for the lifetime of the agent.
+# Owns the conversation handle for an agent: the message array, the
+# +on_message+ callbacks, and the +tool_use+ ↔ +tool_result+ invariant that
+# keeps tool calls and their results consistent.
 #
 #   agent.session.add(msg)                  # append + fire callbacks
 #   agent.session.set([msg1, msg2])         # bulk replace (silent)
@@ -31,12 +28,6 @@ class Riffer::Agent::Session
   end
 
   # Registers a callback invoked once per message appended via +#add+.
-  #
-  # Callbacks do NOT fire for +#set+, +#unset+, +#remove+, or +#update+.
-  # Returns +self+ to allow chaining.
-  #
-  # Raises Riffer::ArgumentError if no block is given.
-  #
   #--
   #: () { (Riffer::Messages::Base) -> void } -> self
   def on_message(&block)
@@ -45,13 +36,9 @@ class Riffer::Agent::Session
     self
   end
 
-  # Appends +message+ and fires every registered callback once with it.
-  #
-  # Pass +silent: true+ to skip +on_message+ callbacks — used for
-  # non-inference inputs like user messages, which subscribers don't
-  # expect to observe through the callback channel. Inference-produced
-  # messages (Assistant, Tool) always go through +add+ without +silent+.
-  #
+  # Appends +message+ and fires every registered callback once with it. Pass
+  # +silent: true+ to skip callbacks — used for non-inference inputs like user
+  # messages that subscribers don't expect on the callback channel.
   #--
   #: (Riffer::Messages::Base, ?silent: bool) -> Riffer::Messages::Base
   def add(message, silent: false)
@@ -60,13 +47,7 @@ class Riffer::Agent::Session
     message
   end
 
-  # Replaces the message history wholesale. Does NOT fire +on_message+
-  # callbacks; registered callbacks persist across the swap.
-  #
-  # Used for seeding, guardrail rewrites, and history healing — cases
-  # where firing callbacks would double-emit messages that subscribers
-  # have already observed (or never produced).
-  #
+  # Replaces the message history wholesale
   #--
   #: (Array[Riffer::Messages::Base]) -> self
   def set(messages)
@@ -74,9 +55,7 @@ class Riffer::Agent::Session
     self
   end
 
-  # Clears the session. Does NOT fire +on_message+ callbacks; registered
-  # callbacks persist.
-  #
+  # Clears the session.
   #--
   #: () -> self
   def unset
@@ -84,18 +63,10 @@ class Riffer::Agent::Session
     self
   end
 
-  # Removes a message by id. When the target is an assistant message that
-  # carries +tool_calls+, every +Riffer::Messages::Tool+ result whose
-  # +tool_call_id+ matches one of those calls is removed atomically — keeping
-  # the +tool_use+ ↔ +tool_result+ invariant intact.
-  #
-  # Raises Riffer::ArgumentError when called on a +Riffer::Messages::Tool+
-  # message — that would orphan the parent's +tool_use+. Use
-  # +#update+ to rewrite a tool result instead.
-  #
-  # Returns the removed message, or +nil+ when no message has the given id
-  # (idempotent).
-  #
+  # Removes a message by id, cascading to drop the +Tool+ results of a removed
+  # assistant's +tool_calls+ so the +tool_use+ ↔ +tool_result+ invariant holds.
+  # Raises on a +Tool+ message — that would orphan its parent; use +#update+
+  # instead. Returns +nil+ if no message matches.
   #--
   #: (id: String) -> Riffer::Messages::Base?
   def remove(id:)
@@ -118,19 +89,10 @@ class Riffer::Agent::Session
     target
   end
 
-  # Partial in-place update. Looks up a message by either +id:+ or
-  # +tool_call_id:+ (exactly one required), constructs a replacement of the
-  # same concrete type with +attrs+ overlaid on the existing fields, and
-  # swaps it in place.
-  #
-  # When the target is an assistant message and the update drops one or more
-  # entries from +tool_calls+, every +Riffer::Messages::Tool+ result whose
-  # +tool_call_id+ matches a dropped call is removed atomically — keeping the
-  # +tool_use+ ↔ +tool_result+ invariant intact.
-  #
-  # Raises Riffer::ArgumentError when neither or both lookup keys are
-  # provided, or when no message matches.
-  #
+  # Partial in-place update: looks up a message by +id:+ or +tool_call_id:+
+  # (exactly one), overlays +attrs+ onto a same-type replacement, and swaps it
+  # in. Dropping +tool_calls+ from an assistant cascades to remove their +Tool+
+  # results, preserving the invariant. Raises on neither/both keys or no match.
   #--
   #: (?id: String?, ?tool_call_id: String?, **untyped) -> Riffer::Messages::Base
   def update(id: nil, tool_call_id: nil, **attrs)
@@ -155,12 +117,9 @@ class Riffer::Agent::Session
     replacement
   end
 
-  # Returns the call_ids of every +tool_call+ on any assistant message that
-  # has no matching +Riffer::Messages::Tool+ result anywhere in history.
-  #
-  # Zero-cost validation hook for callers that want to check the
-  # +tool_use+ ↔ +tool_result+ invariant before mutating or persisting.
-  #
+  # Returns the call_ids of every +tool_call+ with no matching
+  # +Riffer::Messages::Tool+ result anywhere in history — a hook for checking
+  # the +tool_use+ ↔ +tool_result+ invariant before mutating or persisting.
   #--
   #: () -> Array[String]
   def orphaned_tool_call_ids
@@ -171,10 +130,8 @@ class Riffer::Agent::Session
     }
   end
 
-  # Returns +[assistant, pending_tool_calls]+ for the last assistant message.
-  # When there is no assistant message or no pending calls, the second
-  # element is an empty array.
-  #
+  # Returns +[last_assistant, pending_tool_calls]+; the second element is empty
+  # when there's no assistant message or no pending calls.
   #--
   #: () -> [Riffer::Messages::Assistant?, Array[Riffer::Messages::Assistant::ToolCall]]
   def pending_tool_calls
@@ -191,6 +148,7 @@ class Riffer::Agent::Session
     [assistant, assistant.tool_calls.reject { |tc| executed_ids.include?(tc.call_id) }]
   end
 
+  # Yields each message in order, or returns an Enumerator without a block.
   #--
   #: () -> Enumerator[Riffer::Messages::Base, self]
   #: () { (Riffer::Messages::Base) -> void } -> untyped
@@ -199,10 +157,8 @@ class Riffer::Agent::Session
     @messages.each(&block)
   end
 
-  # The number of LLM steps completed in this session, derived from the
-  # count of assistant messages. Used by the agent loop to enforce
+  # The number of LLM steps completed, used by the agent loop to enforce
   # +max_steps+ on resume.
-  #
   #--
   #: () -> Integer
   def steps
@@ -223,6 +179,7 @@ class Riffer::Agent::Session
 
   private
 
+  #--
   #: (Riffer::Messages::Base, Riffer::Messages::Base) -> void
   def cascade_dropped_tool_calls(old, replacement)
     return unless old.is_a?(Riffer::Messages::Assistant)
@@ -234,6 +191,7 @@ class Riffer::Agent::Session
     @messages.reject! { |m| m.is_a?(Riffer::Messages::Tool) && removed_ids.include?(m.tool_call_id) }
   end
 
+  #--
   #: (Riffer::Messages::Base, Hash[Symbol, untyped]) -> Riffer::Messages::Base
   def rebuild_message(old, attrs)
     case old

data/lib/riffer/agent/structured_output/result.rb

@@ -2,19 +2,11 @@
 # rbs_inline: enabled
 
 # Wraps the result of structured output parsing and validation.
-#
-# On success, +object+ contains the validated Hash and +error+ is nil.
-# On failure, +error+ contains the error message and +object+ is nil.
-#
-#   result = structured_output.parse_and_validate(json_string)
-#   if result.success?
-#     result.object  #=> {sentiment: "positive", score: 0.9}
-#   else
-#     result.error   #=> "JSON parse error: ..."
-#   end
-#
 class Riffer::Agent::StructuredOutput::Result
+  # The validated object, or +nil+ on failure.
   attr_reader :object #: Hash[Symbol, untyped]?
+
+  # The error message, or +nil+ on success.
   attr_reader :error #: String?
 
   #--