Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.Prompt

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.Prompt

Record Components:

name - The name of the prompt or prompt template.

title - An optional title for the prompt.

description - An optional description of what this prompt provides.

arguments - A list of arguments to use for templating the prompt.

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.BaseMetadata

Enclosing class:

McpSchema

public static record McpSchema.Prompt(String name, String title, String description, List<McpSchema.PromptArgument> arguments, Map<String,Object> meta)
extends Record
implements McpSchema.BaseMetadata

A prompt or prompt template that the server offers.

Constructor Summary

Constructors

Constructor	Description
Prompt(String name, String title, String description, List<McpSchema.PromptArgument> arguments)
Prompt(String name, String title, String description, List<McpSchema.PromptArgument> arguments, Map<String,Object> meta)	Creates an instance of a Prompt record class.
Prompt(String name, String description, List<McpSchema.PromptArgument> arguments)

Method Summary

Modifier and Type	Method	Description
List<McpSchema.PromptArgument>	arguments()	Returns the value of the arguments record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<String,Object>	meta()	Returns the value of the meta record component.
String	name()	Returns the value of the name record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Prompt

public Prompt(String name,
 String description,
 List<McpSchema.PromptArgument> arguments)

Prompt

public Prompt(String name,
 String title,
 String description,
 List<McpSchema.PromptArgument> arguments)

Prompt

public Prompt(String name,
 String title,
 String description,
 List<McpSchema.PromptArgument> arguments,
 Map<String,Object> meta)

Creates an instance of a Prompt record class.

Parameters:

name - the value for the name record component

title - the value for the title record component

description - the value for the description record component

arguments - the value for the arguments record component

meta - the value for the meta record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Specified by:

name in interface McpSchema.BaseMetadata

Returns:

the value of the name record component

title

public String title()

Returns the value of the title record component.

Specified by:

title in interface McpSchema.BaseMetadata

Returns:

the value of the title record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

arguments

public List<McpSchema.PromptArgument> arguments()

Returns the value of the arguments record component.

Returns:

the value of the arguments record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Returns:

the value of the meta record component