Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.EmbeddedResource

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.EmbeddedResource

Record Components:

annotations - Optional annotations for the client

resource - The resource contents that are embedded

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Annotated, McpSchema.Content

Enclosing class:

McpSchema

public static record McpSchema.EmbeddedResource(McpSchema.Annotations annotations, McpSchema.ResourceContents resource, Map<String,Object> meta)
extends Record
implements McpSchema.Annotated, McpSchema.Content

The contents of a resource, embedded into a prompt or tool call result. It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user.

Constructor Summary

Constructors

Constructor	Description
EmbeddedResource(McpSchema.Annotations annotations, McpSchema.ResourceContents resource)
EmbeddedResource(McpSchema.Annotations annotations, McpSchema.ResourceContents resource, Map<String,Object> meta)	Creates an instance of a EmbeddedResource record class.
EmbeddedResource(List<McpSchema.Role> audience, Double priority, McpSchema.ResourceContents resource)	Deprecated. Only exists for backwards-compatibility purposes.

Method Summary

Modifier and Type	Method	Description
McpSchema.Annotations	annotations()	Returns the value of the annotations record component.
List<McpSchema.Role>	audience()	Deprecated. Only exists for backwards-compatibility purposes.
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.
Map<String,Object>	meta()	Returns the value of the meta record component.
Double	priority()	Deprecated. Only exists for backwards-compatibility purposes.
McpSchema.ResourceContents	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

Methods inherited from interface io.modelcontextprotocol.spec.McpSchema.Content

type

Constructor Details

EmbeddedResource

public EmbeddedResource(McpSchema.Annotations annotations,
 McpSchema.ResourceContents resource)

EmbeddedResource

@Deprecated
public EmbeddedResource(List<McpSchema.Role> audience,
 Double priority,
 McpSchema.ResourceContents resource)

Deprecated.

Only exists for backwards-compatibility purposes. Use EmbeddedResource(Annotations, ResourceContents) instead.

EmbeddedResource

public EmbeddedResource(McpSchema.Annotations annotations,
 McpSchema.ResourceContents resource,
 Map<String,Object> meta)

Creates an instance of a EmbeddedResource record class.

Parameters:

annotations - the value for the annotations record component

resource - the value for the resource record component

meta - the value for the meta record component

Method Details

audience

@Deprecated
public List<McpSchema.Role> audience()

Deprecated.

Only exists for backwards-compatibility purposes. Use annotations() instead.

priority

@Deprecated
public Double priority()

Deprecated.

Only exists for backwards-compatibility purposes. Use annotations() instead.

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.

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

resource

public McpSchema.ResourceContents resource()

Returns the value of the resource record component.

Returns:

the value of the resource record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Content

Returns:

the value of the meta record component