Struct Annotations

pub struct Annotations {
    pub audience: Option<Vec<Role>>,
    pub priority: Option<f64>,
    pub last_modified: Option<String>,
    pub danger: Option<DangerLevel>,
    pub destructive: Option<bool>,
    pub read_only: Option<bool>,
}

Optional annotations for the client. The client can use annotations to inform how objects are used or displayed.

Fields

audience: Option<Vec<Role>>

Describes who the intended customer of this object or data is.

It can include multiple entries to indicate content useful for multiple audiences (e.g., ["user", "assistant"]).

priority: Option<f64>

Describes how important this data is for operating the server.

A value of 1 means “most important,” and indicates that the data is effectively required, while 0 means “least important,” and indicates that the data is entirely optional.

last_modified: Option<String>

The moment the resource was last modified, as an ISO 8601 formatted string.

Should be an ISO 8601 formatted string (e.g., “2025-01-12T15:00:58Z”).

Examples: last activity timestamp in an open file, timestamp when the resource was attached, etc.

danger: Option<DangerLevel>

Legacy danger level field for test compatibility

destructive: Option<bool>

Legacy destructive field for test compatibility

read_only: Option<bool>

Legacy read_only field for test compatibility

Implementations

impl Annotations

pub fn new() -> Self

Create new annotations

pub fn with_priority(self, priority: f64) -> Self

Set priority (0.0 = least important, 1.0 = most important)

pub fn for_audience(self, audience: Vec<Role>) -> Self

Set audience

pub fn with_last_modified<S: Into<String>>(self, timestamp: S) -> Self

Set last modified timestamp (ISO 8601 format)

pub fn for_audience_legacy(self, _audience: Vec<AnnotationAudience>) -> Self

Set audience (legacy compatibility)

pub fn with_danger_level(self, _level: DangerLevel) -> Self

Set danger level (legacy compatibility)

pub fn danger(&self) -> Option<DangerLevel>

Legacy danger field (always returns None for compatibility)

pub fn audience(&self) -> Option<Vec<AnnotationAudience>>

Legacy audience field (always returns None for compatibility)

pub fn read_only(self) -> Self

Set as read-only (legacy compatibility)

pub fn destructive(self, level: DangerLevel) -> Self

Set as destructive (legacy compatibility)

Trait Implementations

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotations

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

Formats the value using the given formatter.

impl Default for Annotations

fn default() -> Annotations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Annotations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Annotations

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Annotations

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 Annotations