Struct ToolSet 

pub struct ToolSet { /* private fields */ }

Builder that produces source-qualified tool filter strings (e.g. "builtin:bash", "mcp:*", "custom:foo") for the session’s available_tools list.

Tools are classified by the runtime at registration time, not from name parsing — so add_builtin("foo") matches only tools registered as built-in, even if an MCP server happens to register a tool with the same wire name.

Example

let tools = ToolSet::new()
    .add_builtin_many(BUILTIN_TOOLS_ISOLATED)?
    .add_mcp("*")?
    .add_custom("*")?
    .to_vec();

Implementations

impl ToolSet

pub fn new() -> Self

Construct an empty tool set.

pub fn add_builtin(self, name: &str) -> Result<Self, Error>

Add a single built-in tool pattern. Pass a specific name (e.g. "bash") or "*" to match all built-in tools.

pub fn add_builtin_many<I, S>(self, names: I) -> Result<Self, Error>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Add a list of built-in tool patterns (e.g. BUILTIN_TOOLS_ISOLATED).

pub fn add_custom(self, name: &str) -> Result<Self, Error>

Add a custom tool pattern. Matches tools registered via the SDK’s tools option or via custom agents.

pub fn add_mcp(self, tool_name: &str) -> Result<Self, Error>

Add an MCP tool pattern. Pass the runtime’s canonical wire name (e.g. "github-list_issues") or "*" to match all MCP tools.

pub fn to_vec(&self) -> Vec<String>

Returns a defensive copy of the accumulated filter strings.

pub fn into_vec(self) -> Vec<String>

Returns the accumulated filter strings, consuming the builder.

pub fn len(&self) -> usize

Number of accumulated filter strings.

pub fn is_empty(&self) -> bool

Returns true if no filter strings have been added.

Trait Implementations

impl Clone for ToolSet

fn clone(&self) -> ToolSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSet

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

Formats the value using the given formatter.

impl Default for ToolSet

fn default() -> ToolSet

Returns the “default value” for a type.

impl From<ToolSet> for Vec<String>

fn from(value: ToolSet) -> Self

Converts to this type from the input type.