Add session/setTitle method for client-driven session renaming

Author: daniel-agentee

agent-client-protocol-schema/Cargo.toml

@@ -24,6 +24,7 @@ workspace = true
 [features]
 unstable = [
     "unstable_auth_methods",
+    "unstable_cancel_request",
     "unstable_elicitation",
     "unstable_llm_providers",
     "unstable_mcp_over_acp",
@@ -38,6 +39,7 @@ unstable = [
 # version, so it must be opted into explicitly.
 unstable_protocol_v2 = []
 unstable_auth_methods = []
+unstable_cancel_request = []
 unstable_elicitation = []
 unstable_llm_providers = []
 unstable_mcp_over_acp = []

agent-client-protocol-schema/src/v1/agent.rs

@@ -2242,6 +2242,92 @@ impl SetSessionModeResponse {
     }
 }
 
+/// Request parameters for setting a session title.
+#[serde_as]
+#[skip_serializing_none]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
+#[schemars(extend("x-side" = "agent", "x-method" = SESSION_SET_TITLE_METHOD_NAME))]
+#[serde(rename_all = "camelCase")]
+#[non_exhaustive]
+pub struct SetSessionTitleRequest {
+    /// The ID of the session to set the title for.
+    pub session_id: SessionId,
+    /// The new title for the session.
+    pub title: String,
+    /// The _meta property is reserved by ACP to allow clients and agents to attach additional
+    /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
+    /// these keys.
+    ///
+    /// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
+    #[serde_as(deserialize_as = "DefaultOnError")]
+    #[schemars(extend("x-deserialize-default-on-error" = true))]
+    #[serde(default)]
+    #[serde(rename = "_meta")]
+    pub meta: Option<Meta>,
+}
+
+impl SetSessionTitleRequest {
+    /// Builds [`SetSessionTitleRequest`] with the required request fields set; optional fields start unset or empty.
+    #[must_use]
+    pub fn new(session_id: impl Into<SessionId>, title: impl Into<String>) -> Self {
+        Self {
+            session_id: session_id.into(),
+            title: title.into(),
+            meta: None,
+        }
+    }
+
+    /// The _meta property is reserved by ACP to allow clients and agents to attach additional
+    /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
+    /// these keys.
+    ///
+    /// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
+    #[must_use]
+    pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
+        self.meta = meta.into_option();
+        self
+    }
+}
+
+/// Response to `session/setTitle` method.
+#[serde_as]
+#[skip_serializing_none]
+#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
+#[schemars(extend("x-side" = "agent", "x-method" = SESSION_SET_TITLE_METHOD_NAME))]
+#[serde(rename_all = "camelCase")]
+#[non_exhaustive]
+pub struct SetSessionTitleResponse {
+    /// The _meta property is reserved by ACP to allow clients and agents to attach additional
+    /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
+    /// these keys.
+    ///
+    /// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
+    #[serde_as(deserialize_as = "DefaultOnError")]
+    #[schemars(extend("x-deserialize-default-on-error" = true))]
+    #[serde(default)]
+    #[serde(rename = "_meta")]
+    pub meta: Option<Meta>,
+}
+
+impl SetSessionTitleResponse {
+    /// Builds [`SetSessionTitleResponse`] with the required response fields set; optional fields start unset or empty.
+    #[must_use]
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// The _meta property is reserved by ACP to allow clients and agents to attach additional
+    /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
+    /// these keys.
+    ///
+    /// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
+    #[must_use]
+    pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
+        self.meta = meta.into_option();
+        self
+    }
+}
+
 // Session config options
 
 /// Unique identifier for a session configuration option.
@@ -4293,6 +4379,11 @@ pub struct SessionCapabilities {
     #[schemars(extend("x-deserialize-default-on-error" = true))]
     #[serde(default)]
     pub close: Option<SessionCloseCapabilities>,
+    /// Whether the agent supports `session/setTitle`.
+    #[serde_as(deserialize_as = "DefaultOnError")]
+    #[schemars(extend("x-deserialize-default-on-error" = true))]
+    #[serde(default)]
+    pub set_title: Option<SessionSetTitleCapabilities>,
     /// The _meta property is reserved by ACP to allow clients and agents to attach additional
     /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
     /// these keys.
@@ -4381,6 +4472,13 @@ impl SessionCapabilities {
         self
     }
 
+    /// Whether the agent supports `session/setTitle`.
+    #[must_use]
+    pub fn set_title(mut self, set_title: impl IntoOption<SessionSetTitleCapabilities>) -> Self {
+        self.set_title = set_title.into_option();
+        self
+    }
+
     /// The _meta property is reserved by ACP to allow clients and agents to attach additional
     /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
     /// these keys.
@@ -4636,6 +4734,45 @@ impl SessionCloseCapabilities {
     }
 }
 
+/// Capabilities for the `session/setTitle` method.
+///
+/// By supplying `{}` it means that the agent supports setting session titles.
+#[serde_as]
+#[skip_serializing_none]
+#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
+#[non_exhaustive]
+pub struct SessionSetTitleCapabilities {
+    /// The _meta property is reserved by ACP to allow clients and agents to attach additional
+    /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
+    /// these keys.
+    ///
+    /// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
+    #[serde_as(deserialize_as = "DefaultOnError")]
+    #[schemars(extend("x-deserialize-default-on-error" = true))]
+    #[serde(default)]
+    #[serde(rename = "_meta")]
+    pub meta: Option<Meta>,
+}
+
+impl SessionSetTitleCapabilities {
+    /// Builds an empty [`SessionSetTitleCapabilities`]; use builder methods to advertise supported sub-capabilities.
+    #[must_use]
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// The _meta property is reserved by ACP to allow clients and agents to attach additional
+    /// metadata to their interactions. Implementations MUST NOT make assumptions about values at
+    /// these keys.
+    ///
+    /// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
+    #[must_use]
+    pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
+        self.meta = meta.into_option();
+        self
+    }
+}
+
 /// Prompt capabilities supported by the agent in `session/prompt` requests.
 ///
 /// Baseline agent functionality requires support for [`ContentBlock::Text`]
@@ -4838,6 +4975,8 @@ pub struct AgentMethodNames {
     pub session_load: &'static str,
     /// Method for setting the mode for a session.
     pub session_set_mode: &'static str,
+    /// Method for setting the title for a session.
+    pub session_set_title: &'static str,
     /// Method for setting a configuration option for a session.
     pub session_set_config_option: &'static str,
     /// Method for sending a prompt to the agent.
@@ -4905,6 +5044,7 @@ pub const AGENT_METHOD_NAMES: AgentMethodNames = AgentMethodNames {
     session_new: SESSION_NEW_METHOD_NAME,
     session_load: SESSION_LOAD_METHOD_NAME,
     session_set_mode: SESSION_SET_MODE_METHOD_NAME,
+    session_set_title: SESSION_SET_TITLE_METHOD_NAME,
     session_set_config_option: SESSION_SET_CONFIG_OPTION_METHOD_NAME,
     session_prompt: SESSION_PROMPT_METHOD_NAME,
     session_cancel: SESSION_CANCEL_METHOD_NAME,
@@ -4958,6 +5098,8 @@ pub(crate) const SESSION_NEW_METHOD_NAME: &str = "session/new";
 pub(crate) const SESSION_LOAD_METHOD_NAME: &str = "session/load";
 /// Method name for setting the mode for a session.
 pub(crate) const SESSION_SET_MODE_METHOD_NAME: &str = "session/set_mode";
+/// Method name for setting the title for a session.
+pub(crate) const SESSION_SET_TITLE_METHOD_NAME: &str = "session/setTitle";
 /// Method name for setting a configuration option for a session.
 pub(crate) const SESSION_SET_CONFIG_OPTION_METHOD_NAME: &str = "session/set_config_option";
 /// Method name for sending a prompt.
@@ -5112,6 +5254,13 @@ pub enum ClientRequest {
     ///
     /// See protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)
     SetSessionModeRequest(SetSessionModeRequest),
+    /// Sets the title for a session.
+    ///
+    /// Empty titles are valid and request that the agent clear the session title.
+    ///
+    /// This method can be called at any time during a session, whether the Agent is
+    /// idle or actively generating a response.
+    SetSessionTitleRequest(SetSessionTitleRequest),
     /// Sets the current value for a session configuration option.
     SetSessionConfigOptionRequest(SetSessionConfigOptionRequest),
     /// Processes a user prompt within a session.
@@ -5189,6 +5338,7 @@ impl ClientRequest {
             Self::ResumeSessionRequest(_) => AGENT_METHOD_NAMES.session_resume,
             Self::CloseSessionRequest(_) => AGENT_METHOD_NAMES.session_close,
             Self::SetSessionModeRequest(_) => AGENT_METHOD_NAMES.session_set_mode,
+            Self::SetSessionTitleRequest(_) => AGENT_METHOD_NAMES.session_set_title,
             Self::SetSessionConfigOptionRequest(_) => AGENT_METHOD_NAMES.session_set_config_option,
             Self::PromptRequest(_) => AGENT_METHOD_NAMES.session_prompt,
             #[cfg(feature = "unstable_nes")]
@@ -5248,6 +5398,8 @@ pub enum AgentResponse {
     CloseSessionResponse(#[serde(default)] CloseSessionResponse),
     /// Successful result returned for a `session/set_mode` request.
     SetSessionModeResponse(#[serde(default)] SetSessionModeResponse),
+    /// Successful result returned for a `session/setTitle` request.
+    SetSessionTitleResponse(#[serde(default)] SetSessionTitleResponse),
     /// Successful result returned for a `session/set_config_option` request.
     SetSessionConfigOptionResponse(SetSessionConfigOptionResponse),
     /// Successful result returned for a `session/prompt` request.
@@ -6136,6 +6288,43 @@ mod test_serialization {
         }
     }
 
+    #[test]
+    fn test_set_session_title_request_roundtrip() {
+        let original = SetSessionTitleRequest::new("sess_1", "A clearer thread title");
+        let json = serde_json::to_value(&original).unwrap();
+        assert_eq!(
+            json,
+            json!({
+                "sessionId": "sess_1",
+                "title": "A clearer thread title"
+            })
+        );
+        let roundtripped: SetSessionTitleRequest = serde_json::from_value(json).unwrap();
+        assert_eq!(original, roundtripped);
+    }
+
+    #[test]
+    fn test_set_session_title_response_roundtrip() {
+        let original = SetSessionTitleResponse::new();
+        let json = serde_json::to_value(&original).unwrap();
+        assert_eq!(json, json!({}));
+        let roundtripped: SetSessionTitleResponse = serde_json::from_value(json).unwrap();
+        assert_eq!(original, roundtripped);
+    }
+
+    #[test]
+    fn test_set_session_title_capabilities_serialization() {
+        assert_eq!(
+            serde_json::to_value(
+                SessionCapabilities::new().set_title(SessionSetTitleCapabilities::new())
+            )
+            .unwrap(),
+            json!({
+                "setTitle": {}
+            })
+        );
+    }
+
     #[cfg(feature = "unstable_boolean_config")]
     #[test]
     fn test_session_config_option_value_id_serialize() {