Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.PromptArgument

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.PromptArgument

Record Components:

name - The name of the argument.

title - An optional title for the argument, which can be used in UI

description - A human-readable description of the argument.

required - Whether this argument must be provided.

All Implemented Interfaces:

McpSchema.BaseMetadata

Enclosing class:

McpSchema

public static record McpSchema.PromptArgument(String name, String title, String description, Boolean required)
extends Record
implements McpSchema.BaseMetadata

Describes an argument that a prompt can accept.

Constructor Summary

Constructors

Constructor	Description
PromptArgument(String name, String description, Boolean required)
PromptArgument(String name, String title, String description, Boolean required)	Creates an instance of a PromptArgument record class.

Method Summary

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

PromptArgument

public PromptArgument(String name,
 String description,
 Boolean required)

PromptArgument

public PromptArgument(String name,
 String title,
 String description,
 Boolean required)

Creates an instance of a PromptArgument 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

required - the value for the required 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

required

public Boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component