Prompt

data class Prompt(val name: String, val description: String? = null, val arguments: List<PromptArgument>? = null, val title: String? = null, val icons: List<Icon>? = null, val meta: JsonObject? = null) : WithMeta(source)

A prompt or prompt template that the server offers.

Prompts can be static messages or templates that accept arguments for dynamic content generation.

Constructors

Link copied to clipboard
constructor(name: String, description: String? = null, arguments: List<PromptArgument>? = null, title: String? = null, icons: List<Icon>? = null, meta: JsonObject? = null)

Properties

Link copied to clipboard
open val _meta: JsonObject
Link copied to clipboard

Optional list of arguments to use for templating the prompt. If present, the prompt is a template that requires these arguments to be filled in.

Link copied to clipboard

An optional description of what this prompt provides and when to use it.

Link copied to clipboard
val icons: List<Icon>?

Optional set of sized icons that clients can display in their user interface. Clients MUST support at least PNG and JPEG formats. Clients SHOULD also support SVG and WebP formats.

Link copied to clipboard
@SerialName(value = "_meta")
open override val meta: JsonObject?

Optional metadata for this prompt.

Link copied to clipboard

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

Link copied to clipboard

Optional human-readable display name for this prompt. 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.