Struct ToolBehaviorHints

pub struct ToolBehaviorHints {
    pub read_only: Option<bool>,
    pub destructive: Option<bool>,
    pub idempotent: Option<bool>,
    pub requires_auth: Option<bool>,
    pub long_running: Option<bool>,
    pub resource_intensive: Option<bool>,
    pub cacheable: Option<bool>,
}

Tool behavior hints for clients to understand tool characteristics

Fields

read_only: Option<bool>

Tool only reads data without making changes

destructive: Option<bool>

Tool makes destructive changes that cannot be easily undone

idempotent: Option<bool>

Tool produces the same output for the same input (no side effects)

requires_auth: Option<bool>

Tool requires authentication or special permissions

long_running: Option<bool>

Tool may take a long time to execute

resource_intensive: Option<bool>

Tool may consume significant system resources

cacheable: Option<bool>

Tool provides cacheable results

Implementations

impl ToolBehaviorHints

pub fn new() -> Self

Create a new empty set of behavior hints

pub fn read_only(self) -> Self

Mark tool as read-only (no destructive changes)

pub fn destructive(self) -> Self

Mark tool as destructive (makes changes that cannot be easily undone)

pub fn idempotent(self) -> Self

Mark tool as idempotent (same input produces same output)

pub fn requires_auth(self) -> Self

Mark tool as requiring authentication

pub fn long_running(self) -> Self

Mark tool as potentially long-running

pub fn resource_intensive(self) -> Self

Mark tool as resource-intensive

pub fn cacheable(self) -> Self

Mark tool results as cacheable

Trait Implementations

impl Clone for ToolBehaviorHints

fn clone(&self) -> ToolBehaviorHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolBehaviorHints

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

Formats the value using the given formatter.

impl Default for ToolBehaviorHints

fn default() -> ToolBehaviorHints

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolBehaviorHints

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ToolBehaviorHints> for ToolAnnotations

fn from(hints: &ToolBehaviorHints) -> Self

Converts to this type from the input type.

impl PartialEq for ToolBehaviorHints

fn eq(&self, other: &ToolBehaviorHints) -> 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 ToolBehaviorHints

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 ToolBehaviorHints