Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.server

Record Class McpStatelessServerFeatures.SyncResourceSpecification

java.lang.Object

java.lang.Record

io.modelcontextprotocol.server.McpStatelessServerFeatures.SyncResourceSpecification

Record Components:

resource - The resource definition including name, description, and MIME type

readHandler - The function that handles resource read requests. The function's argument is a McpSchema.ReadResourceRequest.

Enclosing class:

McpStatelessServerFeatures

public static record McpStatelessServerFeatures.SyncResourceSpecification(McpSchema.Resource resource, BiFunction<McpTransportContext,McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult> readHandler)
extends Record

Specification of a resource with its synchronous handler function. Resources provide context to AI models by exposing data such as:

• File contents
• Database records
• API responses
• System information
• Application state

Constructor Summary

Constructors

Constructor	Description
SyncResourceSpecification(McpSchema.Resource resource, BiFunction<McpTransportContext,McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult> readHandler)	Creates an instance of a SyncResourceSpecification 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.
BiFunction<McpTransportContext,McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult>	readHandler()	Returns the value of the readHandler record component.
McpSchema.Resource	resource()	Returns the value of the resource 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

SyncResourceSpecification

public SyncResourceSpecification(McpSchema.Resource resource,
 BiFunction<McpTransportContext,McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult> readHandler)

Creates an instance of a SyncResourceSpecification record class.

Parameters:

resource - the value for the resource record component

readHandler - the value for the readHandler 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.

resource

public McpSchema.Resource resource()

Returns the value of the resource record component.

Returns:

the value of the resource record component

readHandler

public BiFunction<McpTransportContext,McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult> readHandler()

Returns the value of the readHandler record component.

Returns:

the value of the readHandler record component