Struct RenderFormTool 

pub struct RenderFormTool;

Tool for rendering forms to collect user input.

This tool generates form UI components that allow agents to collect structured input from users. The form includes various field types and returns submitted data via UiEvent::FormSubmit.

Supported Field Types

• text: Single-line text input (default)
• email: Email address input with validation
• password: Password input (masked)
• number: Numeric input
• select: Dropdown selection from options
• textarea: Multi-line text input

Example JSON Parameters

{
  "title": "Contact Form",
  "description": "Please fill out your details",
  "fields": [
    { "name": "email", "label": "Email", "type": "email", "required": true },
    { "name": "message", "label": "Message", "type": "textarea" }
  ],
  "submit_label": "Send"
}

Implementations

impl RenderFormTool

pub fn new() -> Self

Trait Implementations

impl Default for RenderFormTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for RenderFormTool

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,