Struct Parameter 

pub struct Parameter {
    pub name: String,
    pub type_hint: String,
    pub description: String,
    pub required: bool,
}

Parameter definition for an action

Fields

name: String

Parameter name (e.g., “output”, “connection_id”)

type_hint: String

Type hint for the LLM (e.g., “string”, “number”, “boolean”).

A parameter whose value comes from a closed set declares it here as a quoted alternation — "utf8" | "hex" — normally written via Parameter::with_choices. Parameter::choices parses it back out. The spelling is deliberate: it reads as a TypeScript-style literal union in the LLM prompt, maps to "enum" in the native tool-calling schemas, and cannot collide with the type unions some protocols already use ("number | string", "array | object"), whose segments are unquoted.

description: String

Description of what this parameter does

required: bool

Whether this parameter is required

Implementations

impl Parameter

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

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

Declare the closed set of values this parameter accepts.

Encodes the choices into type_hint as a quoted alternation ("utf8" | "hex"), which is what Parameter::choices recognises. The TUI composer renders such a parameter as a cycling selector instead of a free-text field, and the native tool schemas advertise the set as a JSON-Schema enum. The chosen value is always submitted as a plain string.

Parameter { name: "encoding".into(), type_hint: "string".into(), … }
    .with_choices(["utf8", "hex"])

pub fn choices(&self) -> Option<Vec<String>>

The closed set of values this parameter accepts, if it declares one.

Recognises a type_hint that is a quoted alternation of two or more literals ("utf8" | "hex", as written by Parameter::with_choices). Unquoted alternations — the type unions like "number | string" used by jsonrpc and torrent_tracker — are deliberately not choices: they name kinds of values, not the values themselves.

Trait Implementations

impl Clone for Parameter

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 Parameter

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

Formats the value using the given formatter.