Struct ParameterDefinition 

pub struct ParameterDefinition {
    pub name: String,
    pub type_hint: String,
    pub description: String,
    pub required: bool,
    pub example: Value,
    pub default: Option<Value>,
}

Definition of a configuration parameter for prompt generation

This describes a startup parameter that a protocol accepts, including its name, type, description, and an example value.

Fields

name: String

Parameter name (e.g., “certificate_mode”, “max_connections”)

type_hint: String

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

description: String

Human-readable description of what this parameter does

required: bool

Whether this parameter is required

example: Value

JSON example showing a valid value for this parameter

default: Option<Value>

The value the protocol uses when the caller omits this parameter, when there is one.

Declared where the code already falls back to a fixed value, so the operator can see the value before choosing to change it: the dashboard’s create form pre-fills it (and does not submit it unless edited), and get_protocol_docs prints it. None means omitting the parameter changes behaviour in a way no single value describes — a feature switched off, a value derived from something else — or the parameter is required.

Must parse as Self::type_hint; tests/startup_param_defaults_test.rs checks every declaration. Point it at the constant the code falls back to (Some(json!(IDLE_TIMEOUT.as_secs()))), never a literal repeating it, or the two drift.

Implementations

impl ParameterDefinition

pub fn to_prompt_text(&self) -> String

Convert to prompt text format for LLM

Trait Implementations

impl Clone for ParameterDefinition

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 ParameterDefinition

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

Formats the value using the given formatter.

impl Serialize for ParameterDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.