Package io.modelcontextprotocol.spec

Record Class McpSchema.InitializeResult

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.InitializeResult

Record Components:

protocolVersion - The version of the Model Context Protocol that the server wants to use. This may not match the version that the client requested. If the client cannot support this version, it MUST disconnect

capabilities - The capabilities that the server supports

serverInfo - Information about the server implementation

instructions - Instructions describing how to use the server and its features. This can be used by clients to improve the LLM's understanding of available tools, resources, etc. It can be thought of like a "hint" to the model. For example, this information MAY be added to the system prompt

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Meta, McpSchema.Result

Enclosing class:

McpSchema

public static record McpSchema.InitializeResult(String protocolVersion, McpSchema.ServerCapabilities capabilities, McpSchema.Implementation serverInfo, String instructions, Map<String,Object> meta)
extends Record
implements McpSchema.Result

After receiving an initialize request from the client, the server sends this response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.InitializeResult.Builder

Constructor Summary

Constructors

Constructor	Description
InitializeResult(String protocolVersion, McpSchema.ServerCapabilities capabilities, McpSchema.Implementation serverInfo, String instructions)	Deprecated. Use builder(String, ServerCapabilities, Implementation) instead.
InitializeResult(String protocolVersion, McpSchema.ServerCapabilities capabilities, McpSchema.Implementation serverInfo, String instructions, Map<String,Object> meta)	Creates an instance of a InitializeResult record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.InitializeResult.Builder	builder(String protocolVersion, McpSchema.ServerCapabilities capabilities, McpSchema.Implementation serverInfo)
McpSchema.ServerCapabilities	capabilities()	Returns the value of the capabilities 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	instructions()	Returns the value of the instructions record component.
Map<String,Object>	meta()	Returns the value of the meta record component.
String	protocolVersion()	Returns the value of the protocolVersion record component.
McpSchema.Implementation	serverInfo()	Returns the value of the serverInfo 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

InitializeResult

public InitializeResult(String protocolVersion,
 McpSchema.ServerCapabilities capabilities,
 McpSchema.Implementation serverInfo,
 String instructions,
 Map<String,Object> meta)

Creates an instance of a InitializeResult record class.

Parameters:

protocolVersion - the value for the protocolVersion record component

capabilities - the value for the capabilities record component

serverInfo - the value for the serverInfo record component

instructions - the value for the instructions record component

meta - the value for the meta record component

InitializeResult

@Deprecated
public InitializeResult(String protocolVersion,
 McpSchema.ServerCapabilities capabilities,
 McpSchema.Implementation serverInfo,
 String instructions)

Deprecated.

Use builder(String, ServerCapabilities, Implementation) instead.

Method Details

builder

public static McpSchema.InitializeResult.Builder builder(String protocolVersion,
 McpSchema.ServerCapabilities capabilities,
 McpSchema.Implementation serverInfo)

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.

protocolVersion

public String protocolVersion()

Returns the value of the protocolVersion record component.

Returns:

the value of the protocolVersion record component

capabilities

public McpSchema.ServerCapabilities capabilities()

Returns the value of the capabilities record component.

Returns:

the value of the capabilities record component

serverInfo

public McpSchema.Implementation serverInfo()

Returns the value of the serverInfo record component.

Returns:

the value of the serverInfo record component

instructions

public String instructions()

Returns the value of the instructions record component.

Returns:

the value of the instructions record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Meta

Returns:

the value of the meta record component

See Also:

• Specification for notes on _meta usage