Package io.quarkiverse.mcp.server

Interface PromptManager

All Superinterfaces:

FeatureManager<PromptManager.PromptInfo>, Iterable<PromptManager.PromptInfo>

All Known Implementing Classes:

PromptManagerImpl

public interface PromptManager
extends FeatureManager<PromptManager.PromptInfo>

This manager can be used to obtain metadata and register a new prompt programmatically.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	PromptManager.PromptArgument
static interface	PromptManager.PromptArguments
static interface	PromptManager.PromptDefinition	PromptManager.PromptInfo definition.
static interface	PromptManager.PromptInfo	Tool info.

Nested classes/interfaces inherited from interface io.quarkiverse.mcp.server.FeatureManager

FeatureManager.FeatureArguments, FeatureManager.FeatureDefinition<INFO extends FeatureManager.FeatureInfo,ARGUMENTS extends FeatureManager.FeatureArguments,RESPONSE,THIS extends FeatureManager.FeatureDefinition<INFO,ARGUMENTS,RESPONSE,THIS>>, FeatureManager.FeatureInfo, FeatureManager.RequestFeatureArguments

Method Summary

Modifier and Type	Method	Description
PromptManager.PromptInfo	getPrompt(String name)
PromptManager.PromptDefinition	newPrompt(String name)
PromptManager.PromptInfo	removePrompt(String name)	Removes a prompt previously added with newPrompt(String).

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getPrompt

PromptManager.PromptInfo getPrompt(String name)

Parameters:

name -

Returns:

the prompt with the given name, or null

newPrompt

PromptManager.PromptDefinition newPrompt(String name)

Parameters:

name - The name must be unique

Returns:

a new definition builder

See Also:

• FeatureManager.FeatureDefinition.register()

removePrompt

PromptManager.PromptInfo removePrompt(String name)

Removes a prompt previously added with newPrompt(String).

Returns:

the removed prompt or null if no such tool existed