Struct McpPromptArgument 

#[non_exhaustive]
pub struct McpPromptArgument {
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub required: Option<bool>,
}

Describes an argument that a prompt can accept (spec PromptArgument).

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.

name: String

title: Option<String>

description: Option<String>

required: Option<bool>

Implementations

impl PromptArgument

pub fn new<N>(name: N) -> PromptArgument

where N: Into<String>,

pub fn with_title<T>(self, title: T) -> PromptArgument

where T: Into<String>,

pub fn with_description<D>(self, description: D) -> PromptArgument

where D: Into<String>,

pub fn with_required(self, required: bool) -> PromptArgument

Trait Implementations

impl Clone for PromptArgument

fn clone(&self) -> PromptArgument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptArgument

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

Formats the value using the given formatter.

impl Default for PromptArgument

fn default() -> PromptArgument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PromptArgument

fn deserialize<__D>( __deserializer: __D, ) -> Result<PromptArgument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PromptArgument

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 PartialEq for PromptArgument

fn eq(&self, other: &PromptArgument) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PromptArgument

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.

impl StructuralPartialEq for PromptArgument