Struct HelpTool 

pub struct HelpTool {}

Implementations

impl HelpTool

pub fn tool_name() -> String

Returns the name of the tool as a String.

pub fn request_params() -> CallToolRequestParams

Returns a CallToolRequestParams initialized with the current tool’s name.

You can further customize the request by adding arguments or other attributes using the builder pattern. For example:

let args = serde_json::Map::new();
let task_meta = TaskMetadata{ttl: Some(200)}

let params: CallToolRequestParams = MyTool::request_params()
    .with_arguments(args)
    .with_task(task_meta);

Returns

A CallToolRequestParams with the tool name set.

pub fn tool() -> Tool

Constructs and returns a rust_mcp_schema::Tool instance.

The tool includes the name, description, input schema, meta, and title derived from the struct’s attributes.

impl HelpTool

pub fn json_schema() -> Map<String, Value>

Trait Implementations

impl Debug for HelpTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HelpTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HelpTool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.