Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.server

Record Class McpServerFeatures.SyncResourceRegistration

java.lang.Object
java.lang.Record
io.modelcontextprotocol.server.McpServerFeatures.SyncResourceRegistration
Record Components:
resource - The resource definition including name, description, and MIME type
readHandler - The function that handles resource read requests
Enclosing class:
McpServerFeatures
@Deprecated public static record McpServerFeatures.SyncResourceRegistration(McpSchema.Resource resource, Function<McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult> readHandler) extends Record
Deprecated.
This class is deprecated and will be removed in 0.9.0. Use McpServerFeatures.SyncResourceSpecification.
Registration 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

Example resource registration: 


 new McpServerFeatures.SyncResourceRegistration(
     new Resource("docs", "Documentation files", "text/markdown"),
     request -> {
         String content = readFile(request.getPath());
         return new ReadResourceResult(content);
     }
 )

  • Constructor Details

  • Method Details

    • toSpecification

      public McpServerFeatures.SyncResourceSpecification toSpecification()
      Deprecated.

    • toString

      public final String toString()
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      Returns the value of the resource record component.
      Returns:
      the value of the resource record component

    • readHandler

      public Function<McpSchema.ReadResourceRequest,McpSchema.ReadResourceResult> readHandler()
      Deprecated.
      Returns the value of the readHandler record component.
      Returns:
      the value of the readHandler record component