Struct McpToolMetadata 

pub struct McpToolMetadata { /* private fields */ }

Optional application-facing metadata for a generated MCP tool.

Implementations

impl McpToolMetadata

pub const fn new() -> Self

Create empty tool metadata.

pub const fn with_name(self, name: &'static str) -> Self

Override the generated tool name.

pub const fn with_title(self, title: &'static str) -> Self

Set the human-readable tool title.

pub const fn with_description(self, description: &'static str) -> Self

Set the human-readable tool description.

pub const fn with_read_only_hint(self, read_only: bool) -> Self

Set the MCP read-only hint.

pub const fn with_destructive_hint(self, destructive: bool) -> Self

Set the MCP destructive hint.

pub const fn with_idempotent_hint(self, idempotent: bool) -> Self

Set the MCP idempotent hint.

pub const fn with_open_world_hint(self, open_world: bool) -> Self

Set the MCP open-world hint.

pub const fn with_icons(self, icons: &'static [McpToolIcon]) -> Self

Set static icon metadata for the generated tool definition.

pub const fn name(self) -> Option<&'static str>

Returns the explicit tool name override.

pub const fn title(self) -> Option<&'static str>

Returns the human-readable tool title.

pub const fn description(self) -> Option<&'static str>

Returns the human-readable tool description.

pub const fn read_only_hint(self) -> Option<bool>

Returns the MCP read-only hint.

pub const fn destructive_hint(self) -> Option<bool>

Returns the MCP destructive hint.

pub const fn idempotent_hint(self) -> Option<bool>

Returns the MCP idempotent hint.

pub const fn open_world_hint(self) -> Option<bool>

Returns the MCP open-world hint.

pub const fn icons(self) -> &'static [McpToolIcon]

Returns static icon metadata.

pub fn tool_annotations(self) -> Option<McpToolAnnotations>

Converts metadata hints into MCP tool annotations.

pub fn tool_icons(self) -> Option<Vec<McpIcon>>

Converts static icon metadata into MCP icon definitions.

pub fn validate(self) -> Result<(), McpToolError>

Validate generated tool metadata.

Errors

Returns McpToolError when hints conflict or text/icon metadata is invalid.

Trait Implementations

impl Clone for McpToolMetadata

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for McpToolMetadata

impl Debug for McpToolMetadata

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

Formats the value using the given formatter.

impl Default for McpToolMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Eq for McpToolMetadata

impl PartialEq for McpToolMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for McpToolMetadata