Skip to main content

ToolDefinition

Struct ToolDefinition 

Source
pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub input_schema: Value,
}
Expand description

Tool definition for MCP tools/list response.

This struct represents a tool that can be called by MCP clients. It includes the tool’s name, description, and JSON Schema for input validation. This is a type-erased version that allows storing multiple tools with different input types in the same collection.

§Fields

  • name: Unique identifier for the tool
  • description: Human-readable description of what the tool does
  • input_schema: JSON Schema defining the expected input parameters

§Example

use solidmcp::handler::ToolDefinition;
use serde_json::json;

let tool = ToolDefinition {
    name: "calculate".to_string(),
    description: "Perform arithmetic operations".to_string(),
    input_schema: json!({
        "type": "object",
        "properties": {
            "a": { "type": "number" },
            "b": { "type": "number" },
            "operation": {
                "type": "string",
                "enum": ["add", "subtract", "multiply", "divide"]
            }
        },
        "required": ["a", "b", "operation"]
    }),
};

Fields§

§name: String§description: String§input_schema: Value

Implementations§

Source§

impl ToolDefinition

Source

pub fn from_schema<T: JsonSchema>( name: impl Into<String>, description: impl Into<String>, ) -> Self

Create a new tool definition from a JsonSchema type.

This method automatically generates a JSON Schema from a Rust type that implements the JsonSchema trait. This is the preferred way to create tool definitions when using the framework API.

§Type Parameters
  • T: Type that implements schemars::JsonSchema
§Parameters
  • name: The unique name for this tool
  • description: Human-readable description of the tool’s purpose
§Returns

A new ToolDefinition with the schema automatically generated from type T

§Example
use solidmcp::handler::ToolDefinition;
use schemars::JsonSchema;
use serde::Deserialize;

#[derive(JsonSchema, Deserialize)]
struct SearchInput {
    query: String,
    #[serde(default)]
    limit: u32,
}

let tool = ToolDefinition::from_schema::<SearchInput>(
    "search",
    "Search for items matching a query"
);
Source

pub fn to_json(&self) -> Value

Convert to the JSON format expected by MCP protocol.

This method serializes the tool definition into the format required by the MCP protocol for the tools/list response.

§Returns

A JSON value containing the tool’s name, description, and input schema

§Example
let json = tool.to_json();
assert_eq!(json["name"], "calculate");
assert_eq!(json["description"], "Perform arithmetic operations");
assert!(json["input_schema"].is_object());

Trait Implementations§

Source§

impl Clone for ToolDefinition

Source§

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolDefinition

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more