Struct RenderModalTool 

pub struct RenderModalTool;

Tool for rendering modal dialogs.

Creates overlay modal dialogs for focused interactions, confirmations, or important messages that require user attention.

Example JSON Parameters

{
  "title": "Confirm Action",
  "message": "Are you sure you want to proceed with this action?",
  "size": "medium",
  "confirm_label": "Yes, Proceed",
  "cancel_label": "Cancel",
  "confirm_action": "confirm_action",
  "cancel_action": "cancel_action"
}

Implementations

impl RenderModalTool

pub fn new() -> Self

Trait Implementations

impl Default for RenderModalTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for RenderModalTool

fn name(&self) -> &str

fn description(&self) -> &str

fn parameters_schema(&self) -> Option<Value>

fn execute<'life0, 'async_trait>( &'life0 self, _ctx: Arc<dyn ToolContext>, args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn enhanced_description(&self) -> String

Returns an enhanced description that may include additional notes. For long-running tools, this includes a warning not to call the tool again if it has already returned a pending status. Default implementation returns the base description.

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.

fn response_schema(&self) -> Option<Value>

fn required_scopes(&self) -> &[&str]

Returns the scopes required to execute this tool.