Struct SystemPrompt 

#[non_exhaustive]
pub struct SystemPrompt {
    pub mode: SystemPromptMode,
    pub content: Vec<ContentBlock>,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Client-provided system-level instructions for a session.

Clients MUST only send this when the Agent advertises session.systemPrompt. Agents that cannot apply it, for example because of an unadvertised mode or an unsupported content block type, MUST return an error instead of creating, resuming, or forking the session.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mode: SystemPromptMode

How the Agent combines content with its own instructions.

Required on the wire, so every request states its mode. In Rust, SystemPrompt::new starts it as SystemPromptMode::Append. Unknown values parse as SystemPromptMode::Other; Agents MUST return an error for modes they do not support.

content: Vec<ContentBlock>

The system prompt content.

Agents advertising the capability MUST accept ContentBlock::Text. Clients MUST NOT send other content block types until a future capability allows them, and Agents MUST return an error for content blocks they do not support, including unknown types preserved as ContentBlock::Other.

meta: Option<Meta>

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

Implementations

impl SystemPrompt

pub fn new(content: Vec<ContentBlock>) -> Self

Available on crate feature unstable_session_system_prompt only.

Builds SystemPrompt with the required fields set; optional fields start unset or empty.

mode starts as SystemPromptMode::Append; use SystemPrompt::mode to request another mode.

pub fn mode(self, mode: SystemPromptMode) -> Self

Available on crate feature unstable_session_system_prompt only.

How the Agent combines content with its own instructions.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

Available on crate feature unstable_session_system_prompt only.

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

Trait Implementations

impl Clone for SystemPrompt

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemPrompt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemPrompt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SystemPrompt

impl JsonSchema for SystemPrompt

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SystemPrompt

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SystemPrompt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SystemPrompt