Enum ToolKind 

#[non_exhaustive]
pub enum ToolKind {
    Function,
    Dynamic,
    ProviderDefined {
        id: String,
        args: JsonObject,
    },
    ProviderExecuted {
        id: String,
        args: JsonObject,
        supports_deferred_results: bool,
    },
}

Who defines and who executes a tool.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Function

Application-defined schema, executed by the application (with an execute function) or by the caller (without one).

Dynamic

Defined at runtime (MCP and similar); input and output are untyped.

ProviderDefined

Schema defined by the provider, executed by the application.

Fields

id: String

Provider tool id in <provider>.<tool> form.

args: JsonObject

Provider-specific configuration.

ProviderExecuted

Defined and executed by the provider.

Fields

id: String

Provider tool id in <provider>.<tool> form.

args: JsonObject

Provider-specific configuration.

supports_deferred_results: bool

The result may arrive in a later turn than the call.

Implementations

impl ToolKind

pub fn is_provider(&self) -> bool

Returns true for provider-defined and provider-executed tools.

pub fn is_provider_executed(&self) -> bool

Returns true when the provider executes the tool.

pub fn is_dynamic(&self) -> bool

Returns true for dynamic tools.

pub fn provider_id(&self) -> Option<&str>

The provider tool id, for provider tools.

Trait Implementations

impl Clone for ToolKind

fn clone(&self) -> ToolKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolKind

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

Formats the value using the given formatter.

impl Eq for ToolKind

impl PartialEq for ToolKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolKind