Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.CreateMessageResult

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.CreateMessageResult

Record Components:

role - The role of the message sender (typically assistant)

content - The content of the sampled message

model - The name of the model that generated the message

stopReason - The reason why sampling stopped, if known

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Result

Enclosing class:

McpSchema

public static record McpSchema.CreateMessageResult(McpSchema.Role role, McpSchema.Content content, String model, McpSchema.CreateMessageResult.StopReason stopReason, Map<String,Object> meta)
extends Record
implements McpSchema.Result

The client's response to a sampling/create_message request from the server. The client should inform the user before returning the sampled message, to allow them to inspect the response (human in the loop) and decide whether to allow the server to see it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.CreateMessageResult.Builder
static enum	McpSchema.CreateMessageResult.StopReason

Constructor Summary

Constructors

Constructor	Description
CreateMessageResult(McpSchema.Role role, McpSchema.Content content, String model, McpSchema.CreateMessageResult.StopReason stopReason)
CreateMessageResult(McpSchema.Role role, McpSchema.Content content, String model, McpSchema.CreateMessageResult.StopReason stopReason, Map<String,Object> meta)	Creates an instance of a CreateMessageResult record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.CreateMessageResult.Builder	builder()
McpSchema.Content	content()	Returns the value of the content 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	model()	Returns the value of the model record component.
McpSchema.Role	role()	Returns the value of the role record component.
McpSchema.CreateMessageResult.StopReason	stopReason()	Returns the value of the stopReason 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

CreateMessageResult

public CreateMessageResult(McpSchema.Role role,
 McpSchema.Content content,
 String model,
 McpSchema.CreateMessageResult.StopReason stopReason)

CreateMessageResult

public CreateMessageResult(McpSchema.Role role,
 McpSchema.Content content,
 String model,
 McpSchema.CreateMessageResult.StopReason stopReason,
 Map<String,Object> meta)

Creates an instance of a CreateMessageResult record class.

Parameters:

role - the value for the role record component

content - the value for the content record component

model - the value for the model record component

stopReason - the value for the stopReason record component

meta - the value for the meta record component

Method Details

builder

public static McpSchema.CreateMessageResult.Builder builder()

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.

role

public McpSchema.Role role()

Returns the value of the role record component.

Returns:

the value of the role record component

content

public McpSchema.Content content()

Returns the value of the content record component.

Returns:

the value of the content record component

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

stopReason

public McpSchema.CreateMessageResult.StopReason stopReason()

Returns the value of the stopReason record component.

Returns:

the value of the stopReason record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Result

Returns:

the value of the meta record component