Struct PromptArgument

pub struct PromptArgument {
    pub description: Option<String>,
    pub name: String,
    pub required: Option<bool>,
    pub title: Option<String>,
}

Describes an argument that a prompt can accept.

JSON schema

{
 "description": "Describes an argument that a prompt can accept.",
 "type": "object",
 "required": [
   "name"
 ],
 "properties": {
   "description": {
     "description": "A human-readable description of the argument.",
     "type": "string"
   },
   "name": {
     "description": "Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).",
     "type": "string"
   },
   "required": {
     "description": "Whether this argument must be provided.",
     "type": "boolean"
   },
   "title": {
     "description": "Intended for UI and end-user contexts — optimized to be human-readable and easily understood,\neven by those unfamiliar with domain-specific terminology.\n\nIf not provided, the name should be used for display (except for Tool,\nwhere annotations.title should be given precedence over using name,\nif present).",
     "type": "string"
   }
 }
}

Fields

description: Option<String>

A human-readable description of the argument.

name: String

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).

required: Option<bool>

Whether this argument must be provided.

title: Option<String>

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology. If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).

Trait Implementations

impl Clone for PromptArgument

fn clone(&self) -> PromptArgument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptArgument

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PromptArgument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.