Struct StartupParams 

pub struct StartupParams { /* private fields */ }

Type-safe wrapper for startup parameters

Validates that parameters can only be accessed if they were declared in the protocol’s get_startup_parameters() implementation.

Every accessor returns a StartupParamResult: the JSON originates from the LLM (open_server) or an MCP client (start_server), so malformed values must surface as errors to the caller instead of aborting the task.

Implementations

impl StartupParams

pub fn preflight(params: &Value) -> StartupParamResult<()>

Check borrowed JSON before cloning or formatting untrusted startup data.

pub fn preflight_owned(params: &mut Option<Value>) -> StartupParamResult<()>

Refuse an excessive owned value without recursively dropping its children. Call this before an earlier error path can dispose of a constructed value.

pub fn new( params: Value, schema: Vec<ParameterDefinition>, ) -> StartupParamResult<Self>

Create new StartupParams with validation

Arguments

• params - JSON object containing parameter values
• schema - Parameter definitions from protocol’s get_startup_parameters()

Errors

Returns StartupParamError::Undeclared if any key in params is not defined in schema, or StartupParamError::Invalid if params is not an object. An absent parameter set should be represented by None at the caller.

pub fn new_validated( params: Value, schema: Vec<ParameterDefinition>, ) -> StartupParamResult<Self>

Validate declared JSON shapes and required fields before any resource is stopped or registered. Protocol-specific I/O checks still occur at spawn.

pub fn allowed_parameters(&self) -> Vec<String>

Names of the parameters this protocol declares, sorted.

pub fn get_string(&self, key: &str) -> StartupParamResult<String>

Get a required string parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter is missing
• If the parameter is not a string

pub fn get_optional_string( &self, key: &str, ) -> StartupParamResult<Option<String>>

Get an optional string parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not a string

pub fn get_bool(&self, key: &str) -> StartupParamResult<bool>

Get a required boolean parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter is missing
• If the parameter is not a boolean

pub fn get_optional_bool(&self, key: &str) -> StartupParamResult<Option<bool>>

Get an optional boolean parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not a boolean

pub fn get_i64(&self, key: &str) -> StartupParamResult<i64>

Get a required integer parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter is missing
• If the parameter is not an integer

pub fn get_optional_i64(&self, key: &str) -> StartupParamResult<Option<i64>>

Get an optional integer parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not an integer

pub fn get_optional_f64(&self, key: &str) -> StartupParamResult<Option<f64>>

Get an optional number parameter (integer or fraction)

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not a number

pub fn get_u64(&self, key: &str) -> StartupParamResult<u64>

Get a required unsigned integer parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter is missing
• If the parameter is not an unsigned integer

pub fn get_optional_u64(&self, key: &str) -> StartupParamResult<Option<u64>>

Get an optional unsigned integer parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not an unsigned integer

pub fn get_optional_u32(&self, key: &str) -> StartupParamResult<Option<u32>>

Get an optional u32 parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not an unsigned integer or exceeds u32::MAX

pub fn get_object(&self, key: &str) -> StartupParamResult<&Map<String, Value>>

Get a required object/map parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter is missing
• If the parameter is not an object

pub fn get_optional_object( &self, key: &str, ) -> StartupParamResult<Option<&Map<String, Value>>>

Get an optional object/map parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not an object

pub fn get_array(&self, key: &str) -> StartupParamResult<&Vec<Value>>

Get a required array parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter is missing
• If the parameter is not an array

pub fn get_optional_array( &self, key: &str, ) -> StartupParamResult<Option<&Vec<Value>>>

Get an optional array parameter

Errors

• If the parameter was not declared in get_startup_parameters()
• If the parameter exists but is not an array

Trait Implementations

impl Clone for StartupParams

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 StartupParams

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

Formats the value using the given formatter.