Struct InputRequired 

pub struct InputRequired { /* private fields */ }

An interim result: what the server needs before it can finish.

Examples

use protocol_droid::application::mcp::input_required::InputRequired;
use protocol_droid::domain::ir::JsonObject;

let ask = JsonObject::new(
    r#"{"message":"Name?","requestedSchema":{"type":"object","properties":{"name":{"type":"string"}}}}"#,
)?;
let result = InputRequired::new().elicit("user_name", &ask).into_result();
assert!(result.as_str().contains(r#""resultType":"input_required""#));

Implementations

impl InputRequired

pub fn new() -> Self

An interim result asking for nothing yet.

pub fn elicit(self, key: impl Into<String>, params: &JsonObject) -> Self

Asks the client’s user for input, under key.

pub fn sample(self, key: impl Into<String>, params: &JsonObject) -> Self

Asks the client to sample from a model, under key.

pub fn list_roots(self, key: impl Into<String>) -> Self

Asks the client for its roots, under key.

pub fn with_state(self, sealed: impl Into<String>) -> Self

Carries a sealed requestState the client will echo on its retry.

Takes the sealed form — see RequestContext::seal_state.

pub fn into_result(self) -> JsonObject

The result document.

resultType is written here rather than left to the dispatcher’s envelope, because it is what makes this an interim result at all: the envelope stamps "complete" on anything that does not already say otherwise.

Trait Implementations

impl Clone for InputRequired

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 InputRequired

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

Formats the value using the given formatter.

impl Default for InputRequired

fn default() -> Self

Returns the “default value” for a type.