Struct ToolDef 

pub struct ToolDef { /* private fields */ }

A registered tool: its protocol description plus its entry point.

Implementations

impl ToolDef

pub fn new(tool: Tool, call: CallFn) -> Self

Creates a definition from the protocol description and entry point.

pub fn ui(self, resource_uri: impl Into<String>) -> Self

Renders the tool’s results with an MCP Apps interface: the ui:// URI of a resource registered with ResourceDef::app. The tool must still return text content for hosts without MCP Apps.

pub fn visibility( self, visibility: impl IntoIterator<Item = Visibility>, ) -> Self

Who may call the tool (MCP Apps): [Visibility::App] hides it from the model and leaves it to the app’s interface. Default: both.

This is a hint for hosts, not access control: every client can list and call the tool, and hosts without MCP Apps show it to the model like any other. Protect sensitive tools with OAuth scopes.

pub fn ui_resource(&self) -> Option<&str>

The interface declared with ui.

pub fn scopes<I, S>(self, scopes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Declares the OAuth scopes a caller needs (all of them). Enforced when the HTTP transport requires OAuth; the client gets 403 with an insufficient_scope challenge listing these scopes.

pub fn required_scopes(&self) -> &[String]

The OAuth scopes declared with scopes.

pub fn require_state<T: Send + Sync + 'static>(self) -> Self

Declares that the tool needs shared state of type T.

pub fn tool(&self) -> &Tool

The protocol description.

Trait Implementations

impl Clone for ToolDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolDef

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

Formats the value using the given formatter.