Struct ToolGuideSpec 

pub struct ToolGuideSpec {
    pub tool_name: String,
    pub when_to_use: String,
    pub when_not_to_use: String,
    pub examples: Vec<ToolExample>,
    pub related_tools: Vec<String>,
    pub category: ToolCategory,
}

Serializable specification for a tool guide

This struct can be loaded from JSON or YAML files and implements the ToolGuide trait for use in the prompt building system.

Fields

tool_name: String

Unique tool identifier

when_to_use: String

When to use this tool

when_not_to_use: String

When NOT to use this tool

examples: Vec<ToolExample>

Usage examples

related_tools: Vec<String>

Related tool names

category: ToolCategory

Tool category

Implementations

impl ToolGuideSpec

pub fn from_guide(guide: &dyn ToolGuide) -> Self

Creates a spec from a ToolGuide implementation

Arguments

• guide - Reference to any type implementing ToolGuide

pub fn from_json_str(raw: &str) -> Result<Self, Error>

Parses a guide spec from a JSON string

Errors

Returns an error if the JSON is malformed or missing required fields

pub fn from_yaml_str(raw: &str) -> Result<Self, Error>

Parses a guide spec from a YAML string

Errors

Returns an error if the YAML is malformed or missing required fields

Trait Implementations

impl Clone for ToolGuideSpec

fn clone(&self) -> ToolGuideSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolGuideSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolGuideSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolGuideSpec

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToolGuide for ToolGuideSpec

fn tool_name(&self) -> &str

Returns the tool’s unique name

fn when_to_use(&self) -> &str

Returns guidance on when this tool should be used

fn when_not_to_use(&self) -> &str

Returns guidance on when this tool should NOT be used

fn examples(&self) -> Vec<ToolExample>

Returns usage examples for this tool

fn related_tools(&self) -> Vec<&str>

Returns names of related tools that complement this one

fn category(&self) -> ToolCategory

Returns the category this tool belongs to

impl StructuralPartialEq for ToolGuideSpec