Record Class McpListedResource

java.lang.Object
java.lang.Record
com.soklet.McpListedResource
@Immutable public record McpListedResource(@NonNull String uri, @NonNull String name, @NonNull String mimeType, @Nullable String title, @Nullable String description, @Nullable Long sizeBytes) extends Record
Resource-list entry exposed by v1 MCP endpoints.
Author:
Mark Allen

  • Constructor Details

    • McpListedResource

      public McpListedResource(@NonNull String uri, @NonNull String name, @NonNull String mimeType, @Nullable String title, @Nullable String description, @Nullable Long sizeBytes)
      Creates an instance of a McpListedResource record class.
      Parameters:
      uri - the value for the uri record component
      name - the value for the name record component
      mimeType - the value for the mimeType record component
      title - the value for the title record component
      description - the value for the description record component
      sizeBytes - the value for the sizeBytes record component

  • Method Details

    • fromComponents

      public static @NonNull McpListedResource fromComponents(@NonNull String uri, @NonNull String name, @NonNull String mimeType)
      Creates a minimal resource-list entry without optional metadata.
      Parameters:
      uri - the resource URI
      name - the resource name
      mimeType - the resource MIME type
      Returns:
      a minimal listed-resource entry

    • withTitle

      public @NonNull McpListedResource withTitle(@NonNull String title)
      Returns a copy of this resource entry with a title.
      Parameters:
      title - the title to apply
      Returns:
      a new resource entry with the given title

    • withDescription

      public @NonNull McpListedResource withDescription(@NonNull String description)
      Returns a copy of this resource entry with a description.
      Parameters:
      description - the description to apply
      Returns:
      a new resource entry with the given description

    • withSizeBytes

      public @NonNull McpListedResource withSizeBytes(@NonNull Long sizeBytes)
      Returns a copy of this resource entry with a size metadata value.
      Parameters:
      sizeBytes - the non-negative size in bytes
      Returns:
      a new resource entry with the given size

    • 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.

    • uri

      public @NonNull String uri()
      Returns the value of the uri record component.
      Returns:
      the value of the uri record component

    • name

      public @NonNull String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • mimeType

      public @NonNull String mimeType()
      Returns the value of the mimeType record component.
      Returns:
      the value of the mimeType record component

    • title

      public @Nullable String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • description

      public @Nullable String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • sizeBytes

      public @Nullable Long sizeBytes()
      Returns the value of the sizeBytes record component.
      Returns:
      the value of the sizeBytes record component