kotlin-sdk-core/io.modelcontextprotocol.kotlin.sdk.types/PromptArgument

PromptArgument

data class PromptArgument(val name: String, val description: String? = null, val required: Boolean? = null, val title: String? = null)(source)

Describes an argument that a prompt can accept.

Arguments allow prompts to be templated with user-provided values.

Constructors

PromptArgument

constructor(name: String, description: String? = null, required: Boolean? = null, title: String? = null)

Properties

description

val description: String?

A human-readable description of the argument, explaining what it's for and what values are expected.

name

val name: String

The programmatic identifier for this argument. Intended for logical use and API identification. If title is not provided, this should be used as a fallback display name.

required

val required: Boolean?

Whether this argument must be provided when using the prompt. If true, the client must supply a value for this argument.

title

val title: String?

Optional human-readable display name for this argument. Intended for UI and end-user contexts, optimized to be easily understood even by those unfamiliar with domain-specific terminology. If not provided, name should be used for display purposes.