Package dev.tachyonmcp.api.server.features.prompts

Interface PromptDescriptor

All Superinterfaces:

HasMeta, ServerFeature.Descriptor

@Immutable
public interface PromptDescriptor
extends ServerFeature.Descriptor, HasMeta

Descriptor for a server-provided prompt template.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PromptDescriptor.Builder	Builder for PromptDescriptor.

Method Summary

Modifier and Type	Method	Description
@Nullable List<PromptArgument>	arguments()	Optional arguments accepted by this prompt.
static PromptDescriptor.Builder	builder()	Creates a new builder for PromptDescriptor.
default void	check()	Validates the prompt descriptor's name.
@Nullable String	description()	Optional description of this prompt.
@Nullable String	extensionId()	Optional identifier of the extension that owns this prompt.
@Nullable List<Icon>	icons()	Optional icons for this prompt.
@Nullable JsonSchema	inputSchema()	Optional JSON schema describing the prompt's arguments.
@Nullable Map<String,Object>	meta()	Optional protocol extension metadata.
String	name()	The prompt name, unique within the server.
static PromptDescriptor	of(String name, @Nullable String description, @Nullable String title, @Nullable List<PromptArgument> arguments, @Nullable JsonSchema inputSchema)	Creates a prompt descriptor with the given fields.
static PromptDescriptor	of(String name, @Nullable String description, @Nullable String title, @Nullable List<PromptArgument> arguments, @Nullable JsonSchema inputSchema, @Nullable List<Icon> icons)	Creates a prompt descriptor with the given fields, including icons.
static PromptDescriptor	of(String name, String description)	Creates a prompt descriptor with just a name and description.
@Nullable String	title()	Optional human-readable title.

Method Details

name

String name()

The prompt name, unique within the server.

Specified by:

name in interface ServerFeature.Descriptor

title

@Nullable String title()

Optional human-readable title.

description

@Nullable String description()

Optional description of this prompt.

arguments

@Nullable List<PromptArgument> arguments()

Optional arguments accepted by this prompt.

inputSchema

@Nullable JsonSchema inputSchema()

Optional JSON schema describing the prompt's arguments.

icons

@Nullable List<Icon> icons()

Optional icons for this prompt.

extensionId

@Nullable String extensionId()

Optional identifier of the extension that owns this prompt.

meta

@Nullable Map<String,Object> meta()

Optional protocol extension metadata.

Specified by:

meta in interface HasMeta

Returns:

the metadata map, or null if none

check

@Check
default void check()

Validates the prompt descriptor's name.

Throws:

IllegalArgumentException - if the name is blank

builder

static PromptDescriptor.Builder builder()

Creates a new builder for PromptDescriptor.

of

static PromptDescriptor of(String name,
 @Nullable String description,
 @Nullable String title,
 @Nullable List<PromptArgument> arguments,
 @Nullable JsonSchema inputSchema)

Creates a prompt descriptor with the given fields.

of

static PromptDescriptor of(String name,
 @Nullable String description,
 @Nullable String title,
 @Nullable List<PromptArgument> arguments,
 @Nullable JsonSchema inputSchema,
 @Nullable List<Icon> icons)

Creates a prompt descriptor with the given fields, including icons.

of

static PromptDescriptor of(String name,
 String description)

Creates a prompt descriptor with just a name and description.