Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.PromptReference

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.PromptReference

Record Components:

type - The reference type identifier (typically "ref/prompt")

name - The name of the prompt

title - An optional title for the prompt

All Implemented Interfaces:

McpSchema.BaseMetadata, McpSchema.CompleteReference

Enclosing class:

McpSchema

public static record McpSchema.PromptReference(String type, String name, String title)
extends Record
implements McpSchema.CompleteReference, McpSchema.BaseMetadata

Identifies a prompt for completion requests.

Constructor Summary

Constructors

Constructor	Description
PromptReference(String name)
PromptReference(String type, String name)
PromptReference(String type, String name, String title)	Creates an instance of a PromptReference record class.

Method Summary

Modifier and Type	Method	Description
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.
String	identifier()
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.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

PromptReference

public PromptReference(String type,
 String name)

PromptReference

public PromptReference(String name)

PromptReference

public PromptReference(String type,
 String name,
 String title)

Creates an instance of a PromptReference record class.

Parameters:

type - the value for the type record component

name - the value for the name record component

title - the value for the title record component

Method Details

identifier

public String identifier()

Specified by:

identifier in interface McpSchema.CompleteReference

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.

type

public String type()

Returns the value of the type record component.

Specified by:

type in interface McpSchema.CompleteReference

Returns:

the value of the type record component

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