Package io.modelcontextprotocol.spec

Record Class McpSchema.ResourceTemplate

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ResourceTemplate

Record Components:

uriTemplate - A URI template that can be used to generate URIs for this 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.

annotations - Optional annotations for the client. The client can use annotations to inform how objects are used or displayed.

icons - Optional list of icons for this resource template.

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Annotated, McpSchema.Identifier, McpSchema.Meta

Enclosing class:

McpSchema

public static record McpSchema.ResourceTemplate(String uriTemplate, String name, String title, String description, String mimeType, McpSchema.Annotations annotations, Map<String,Object> meta, List<McpSchema.Icon> icons)
extends Record
implements McpSchema.Annotated, McpSchema.Identifier, McpSchema.Meta

Resource templates allow servers to expose parameterized resources using URI

See Also:

• RFC 6570

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ResourceTemplate(String uriTemplate, String name, String description, String mimeType, McpSchema.Annotations annotations)	Deprecated. Use builder(String, String).
ResourceTemplate(String uriTemplate, String name, String title, String description, String mimeType, McpSchema.Annotations annotations)	Deprecated. Use builder(String, String).
ResourceTemplate(String uriTemplate, String name, String title, String description, String mimeType, McpSchema.Annotations annotations, Map<String,Object> meta)	Deprecated. Use builder(String, String).
ResourceTemplate(String uriTemplate, String name, String title, String description, String mimeType, McpSchema.Annotations annotations, Map<String,Object> meta, List<McpSchema.Icon> icons)	Creates an instance of a ResourceTemplate record class.

Method Summary

Modifier and Type	Method	Description
McpSchema.Annotations	annotations()	Returns the value of the annotations record component.
static McpSchema.ResourceTemplate.Builder	builder()	Deprecated.
static McpSchema.ResourceTemplate.Builder	builder(String uriTemplate, String name)
String	description()	Returns the value of the description 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.
List<McpSchema.Icon>	icons()	Returns the value of the icons record component.
Map<String,Object>	meta()	Returns the value of the meta record component.
String	mimeType()	Returns the value of the mimeType record component.
String	name()	Returns the value of the name record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
String	uriTemplate()	Returns the value of the uriTemplate record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ResourceTemplate

public ResourceTemplate(String uriTemplate,
 String name,
 String title,
 String description,
 String mimeType,
 McpSchema.Annotations annotations,
 Map<String,Object> meta,
 List<McpSchema.Icon> icons)

Creates an instance of a ResourceTemplate record class.

Parameters:

uriTemplate - the value for the uriTemplate 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

annotations - the value for the annotations record component

meta - the value for the meta record component

icons - the value for the icons record component

ResourceTemplate

@Deprecated
public ResourceTemplate(String uriTemplate,
 String name,
 String title,
 String description,
 String mimeType,
 McpSchema.Annotations annotations,
 Map<String,Object> meta)

Deprecated.

Use builder(String, String).

ResourceTemplate

@Deprecated
public ResourceTemplate(String uriTemplate,
 String name,
 String title,
 String description,
 String mimeType,
 McpSchema.Annotations annotations)

Deprecated.

Use builder(String, String).

ResourceTemplate

@Deprecated
public ResourceTemplate(String uriTemplate,
 String name,
 String description,
 String mimeType,
 McpSchema.Annotations annotations)

Deprecated.

Use builder(String, String).

Method Details

builder

public static McpSchema.ResourceTemplate.Builder builder(String uriTemplate,
 String name)

builder

@Deprecated
public static McpSchema.ResourceTemplate.Builder builder()

Deprecated.

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.

uriTemplate

public String uriTemplate()

Returns the value of the uriTemplate record component.

Returns:

the value of the uriTemplate 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.

Returns:

the value of the description record component

mimeType

public String mimeType()

Returns the value of the mimeType record component.

Returns:

the value of the mimeType 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:

• Specification for notes on _meta usage

icons

public List<McpSchema.Icon> icons()

Returns the value of the icons record component.

Returns:

the value of the icons record component