Struct AgentTool 

pub struct AgentTool {
    pub id: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub job_token_scopes: Option<Option<Vec<String>>>,
    pub value: Box<ToolValue>,
}

AgentTool : A tool available to an AI agent. Can be a flow module or an external MCP (Model Context Protocol) tool

Fields

id: String

Unique identifier for this tool. Cannot contain spaces - use underscores instead (e.g., ‘get_user_data’ not ‘get user data’)

summary: Option<String>

The name the AI agent calls this tool by, not a human label. On a flowmodule tool it must match ^[a-zA-Z0-9_]+$ - letters, numbers and underscores only (e.g. ‘search_documentation’, not ‘Search documentation’) - and always be set; on an mcp or websearch tool it is a plain label. Put the human-readable explanation in ‘description’.

description: Option<String>

Free-text description of the tool given to the AI to decide when and how to call it. Overrides the description auto-derived from the underlying script.

job_token_scopes: Option<Option<Vec<String>>>

Scopes the token of this tool’s jobs is restricted to, on top of the agent step’s own restriction: a tool can only narrow it.

value: Box<ToolValue>

Implementations

impl AgentTool

pub fn new(id: String, value: ToolValue) -> AgentTool

A tool available to an AI agent. Can be a flow module or an external MCP (Model Context Protocol) tool

Trait Implementations

impl Clone for AgentTool

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 AgentTool

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

Formats the value using the given formatter.

impl Default for AgentTool

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AgentTool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AgentTool

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 AgentTool