Struct InputRequiredResult 

#[non_exhaustive]
pub struct InputRequiredResult {
    pub result_type: ResultType,
    pub input_requests: Option<BTreeMap<String, InputRequest>>,
    pub request_state: Option<String>,
    pub meta: Option<MetaObject>,
}

A result indicating that additional input is needed before the request can be completed.

At least one of input_requests or request_state MUST be present.

Servers MAY send this in response to tools/call, prompts/get, or resources/read. Servers MUST NOT send this for any other request.

Examples

use rmcp::model::InputRequiredResult;

let result = InputRequiredResult::from_request_state("opaque-server-state");
assert!(result.input_requests.is_none());
assert_eq!(result.request_state.as_deref(), Some("opaque-server-state"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

result_type: ResultType

Always "input_required" for this result type.

input_requests: Option<BTreeMap<String, InputRequest>>

Server-initiated requests that the client must fulfill before retrying.

request_state: Option<String>

Opaque request state to be echoed back by the client on retry. Clients MUST NOT inspect, parse, modify, or make any assumptions about the contents.

meta: Option<MetaObject>

Optional protocol-level metadata.

Implementations

impl InputRequiredResult

pub fn new( input_requests: Option<BTreeMap<String, InputRequest>>, request_state: Option<String>, ) -> InputRequiredResult

Creates a new InputRequiredResult with both input requests and request state.

pub fn from_input_requests( input_requests: BTreeMap<String, InputRequest>, ) -> InputRequiredResult

Creates from input requests only.

pub fn from_request_state( request_state: impl Into<String>, ) -> InputRequiredResult

Creates from request state only (e.g. for load shedding).

pub fn with_meta(self, meta: MetaObject) -> InputRequiredResult

Sets optional metadata.

Trait Implementations

impl Clone for InputRequiredResult

fn clone(&self) -> InputRequiredResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InputRequiredResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputRequiredResult

Custom deserializer that requires resultType: "input_required" to prevent greedy matching in the untagged ServerResult enum (which would otherwise swallow empty objects or unknown shapes).

fn deserialize<D>( deserializer: D, ) -> Result<InputRequiredResult, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<InputRequiredResult> for CallToolResponse

fn from(result: InputRequiredResult) -> CallToolResponse

Converts to this type from the input type.

impl From<InputRequiredResult> for GetPromptResponse

fn from(result: InputRequiredResult) -> GetPromptResponse

Converts to this type from the input type.

impl From<InputRequiredResult> for ReadResourceResponse

fn from(result: InputRequiredResult) -> ReadResourceResponse

Converts to this type from the input type.

impl From<InputRequiredResult> for ServerResult

fn from(value: InputRequiredResult) -> ServerResult

Converts to this type from the input type.

impl IntoCallToolResult for InputRequiredResult

fn into_call_tool_result(self) -> Result<CallToolResponse, ErrorData>

impl IntoGetPromptResult for InputRequiredResult

fn into_get_prompt_result(self) -> Result<GetPromptResponse, ErrorData>

impl JsonSchema for InputRequiredResult

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for InputRequiredResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.