Package io.modelcontextprotocol.spec

Record Class McpSchema.Resource

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.Resource
Record Components:
uri - the URI of the resource.
name - A human-readable name for this resource. This can be used by clients to populate UI elements.
title - An optional title for this resource.
description - A description of what this resource represents. This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.
mimeType - The MIME type of this resource, if known.
size - The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known. This can be used by Hosts to display file sizes and estimate context window usage.
annotations - Optional annotations for the client. The client can use annotations to inform how objects are used or displayed.
meta - See specification for notes on _meta usage
All Implemented Interfaces:
McpSchema.Annotated, McpSchema.Identifier, McpSchema.Meta, McpSchema.ResourceContent
Enclosing class:
McpSchema
public static record McpSchema.Resource(String uri, String name, String title, String description, String mimeType, Long size, McpSchema.Annotations annotations, Map<String,Object> meta) extends Record implements McpSchema.ResourceContent
A known resource that the server is capable of reading.

  • Constructor Details

    • Resource

      public Resource(String uri, String name, String title, String description, String mimeType, Long size, McpSchema.Annotations annotations, Map<String,Object> meta)
      Creates an instance of a Resource record class.
      Parameters:
      uri - the value for the uri record component
      name - the value for the name record component
      title - the value for the title record component
      description - the value for the description record component
      mimeType - the value for the mimeType record component
      size - the value for the size record component
      annotations - the value for the annotations record component
      meta - the value for the meta record component

  • Method Details

    • builder

      public static McpSchema.Resource.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.

    • uri

      public String uri()
      Returns the value of the uri record component.
      Specified by:
      uri in interface McpSchema.ResourceContent
      Returns:
      the value of the uri record component

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface McpSchema.Identifier
      Returns:
      the value of the name record component

    • title

      public String title()
      Returns the value of the title record component.
      Specified by:
      title in interface McpSchema.Identifier
      Returns:
      the value of the title record component

    • description

      public String description()
      Returns the value of the description record component.
      Specified by:
      description in interface McpSchema.ResourceContent
      Returns:
      the value of the description record component

    • mimeType

      public String mimeType()
      Returns the value of the mimeType record component.
      Specified by:
      mimeType in interface McpSchema.ResourceContent
      Returns:
      the value of the mimeType record component

    • size

      public Long size()
      Returns the value of the size record component.
      Specified by:
      size in interface McpSchema.ResourceContent
      Returns:
      the value of the size record component

    • annotations

      public McpSchema.Annotations annotations()
      Returns the value of the annotations record component.
      Specified by:
      annotations in interface McpSchema.Annotated
      Returns:
      the value of the annotations 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: