Struct ToolExample 

pub struct ToolExample {
    pub tool_name: String,
    pub description: String,
    pub cli_command: String,
    pub params_json: String,
}

Example tool usage for documentation.

Fields

tool_name: String

Tool name.

description: String

Natural language description of what this does.

cli_command: String

Example CLI command.

params_json: String

Example parameters as JSON.

Trait Implementations

impl Clone for ToolExample

fn clone(&self) -> ToolExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolExample

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolExample

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolExample, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ToolExample

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ToolExample

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

where __S: Serializer,

Serialize this value into the given Serde serializer.