Struct InternalTool 

pub struct InternalTool {
    pub name: String,
    pub description: String,
    pub parameters: Value,
    pub metadata: HashMap<String, Value>,
}

Internal tool representation - the hub format for all protocols.

This type serves as the canonical representation for tools from any source:

• Native tools (e.g., from CATS)
• MCP tools (from Model Context Protocol servers)
• A2A tools (from Agent-to-Agent protocol, future)

Protocol-specific metadata is preserved in the metadata field to enable round-trip conversion without data loss.

Example

use umf::internal::InternalTool;
use serde_json::json;

let tool = InternalTool::new(
    "get_weather",
    "Get the current weather for a location",
    json!({
        "type": "object",
        "properties": {
            "location": { "type": "string", "description": "City name" }
        },
        "required": ["location"]
    }),
);

Fields

name: String

Tool name (unique identifier within a registry).

description: String

Tool description for LLM consumption.

parameters: Value

JSON Schema for tool parameters.

This should follow the JSON Schema specification and typically has the structure:

{
    "type": "object",
    "properties": { ... },
    "required": [ ... ]
}

metadata: HashMap<String, Value>

Protocol-specific metadata preserved through conversion.

Used to store protocol-specific fields that don’t map directly to the internal format, enabling lossless round-trip conversion. Keys are prefixed with the protocol name (e.g., “mcp_annotations”).

Implementations

impl InternalTool

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> Self

Create a new internal tool.

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Add metadata to the tool.

pub fn has_metadata(&self, key: &str) -> bool

Check if the tool has a specific metadata key.

pub fn get_metadata(&self, key: &str) -> Option<&Value>

Get a metadata value by key.

Trait Implementations

impl Clone for InternalTool

fn clone(&self) -> InternalTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InternalTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InternalTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InternalTool

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InternalTool