Skip to main content

SessionSummary

Struct SessionSummary 

Source
pub struct SessionSummary {
    pub provider: String,
    pub title: String,
    pub status: u32,
    pub activity: Option<String>,
    pub project: Option<ProjectInfo>,
    pub working_directory: Option<Uri>,
    pub annotations: Option<AnnotationsSummary>,
    pub resource: Uri,
    pub created_at: String,
    pub modified_at: String,
    pub changes: Option<ChangesSummary>,
    pub meta: Option<JsonObject>,
}
Expand description

Lightweight catalog entry summarizing one session. Surfaced via {@link RootChannelCommands.listSessions | root/listSessions} and root/sessionAdded/root/sessionSummaryChanged notifications.

Aggregation across chats. Once a session contains more than one chat, several SessionSummary fields are derived from the underlying {@link SessionState.chats | chat catalog}. Producers SHOULD follow these rules so clients that only consume the session summary (e.g. a session list) still see meaningful state:

  • status: take the activity bits (Idle / InProgress / InputNeeded / Error — bits 0–4) from the {@link SessionState.defaultChat | default chat} when present, else from the most recently modified chat. Promote InputNeeded whenever any chat in the session needs input, and promote Error whenever any chat is in an error state — both override the default-chat bits. The orthogonal flag bits (IsRead, IsArchived) remain session-scoped.
  • activity: mirror the activity string of the default chat, or of the chat currently driving the promoted status bits when a non-default chat wins (e.g. the chat that raised InputNeeded).
  • modifiedAt: the max of all chats’ modifiedAt.
  • workingDirectory: the session-level default. Individual chats MAY override via {@link ChatSummary.workingDirectory}; aggregating these up is meaningless and SHOULD NOT be attempted.
  • changes: optional roll-up across all chats. Producers MAY sum the per-chat changeset stats or report the most expensive chat’s stats — whichever is cheaper for the host to compute.

Sessions with a single chat trivially satisfy all of the above (the chat’s values pass through unchanged). The rules only matter once a session carries multiple chats.

Fields§

§provider: String

Agent provider ID

§title: String

Session title

§status: u32

Current session status

§activity: Option<String>

Human-readable description of what the session is currently doing

§project: Option<ProjectInfo>

Server-owned project for this session

§working_directory: Option<Uri>

The default working directory URI for this session. Individual chats MAY override via {@link ChatSummary.workingDirectory | their own workingDirectory}; this field acts as the fallback for any chat that does not.

§annotations: Option<AnnotationsSummary>

Lightweight summary of this session’s inline annotations channel (ahp-session:/<uuid>/annotations). Surfaced so badge UI can render annotation / entry counts without subscribing. Absent when the session does not expose an annotations channel.

§resource: Uri

Session URI

§created_at: String

Creation timestamp (ISO 8601, e.g. "2025-03-10T18:42:03.123Z")

§modified_at: String

Last modification timestamp (ISO 8601, e.g. "2025-03-10T18:42:03.123Z")

§changes: Option<ChangesSummary>

Aggregate summary of file changes associated with this session. Servers may populate this to give clients a quick at-a-glance view of the session’s footprint (e.g., for list rendering) without requiring the client to subscribe to a changeset.

§meta: Option<JsonObject>

Lightweight server-defined metadata clients may use for the session presentation. The protocol does not interpret these values; producers SHOULD keep the payload small because summaries appear in session lists and session notifications.

Trait Implementations§

Source§

impl Clone for SessionSummary

Source§

fn clone(&self) -> SessionSummary

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionSummary

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SessionSummary

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SessionSummary

Source§

fn eq(&self, other: &SessionSummary) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SessionSummary

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SessionSummary

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.