io.modelcontextprotocol.spec

类 McpSchema.Resource

java.lang.Object

io.modelcontextprotocol.spec.McpSchema.Resource

所有已实现的接口:

McpSchema.Annotated, McpSchema.Identifier, McpSchema.Meta, McpSchema.ResourceContent

封闭类:

McpSchema

public static class McpSchema.Resource
extends java.lang.Object
implements McpSchema.ResourceContent

A known resource that the server is capable of reading.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	McpSchema.Resource.Builder

构造器概要

构造器

构造器和说明
Resource(java.lang.String uri, java.lang.String name, java.lang.String description, java.lang.String mimeType, java.lang.Long size, McpSchema.Annotations annotations) 已过时。 Only exists for backwards-compatibility purposes. Use builder() instead.
Resource(java.lang.String uri, java.lang.String name, java.lang.String description, java.lang.String mimeType, McpSchema.Annotations annotations) 已过时。 Only exists for backwards-compatibility purposes. Use builder() instead.
Resource(java.lang.String uri, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String mimeType, java.lang.Long size, McpSchema.Annotations annotations) 已过时。 Only exists for backwards-compatibility purposes. Use builder() instead.
Resource(java.lang.String uri, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String mimeType, java.lang.Long size, McpSchema.Annotations annotations, java.util.Map<java.lang.String,java.lang.Object> meta)

方法概要

限定符和类型	方法和说明
McpSchema.Annotations	annotations()
static McpSchema.Resource.Builder	builder()
java.lang.String	description()
java.util.Map<java.lang.String,java.lang.Object>	meta()
java.lang.String	mimeType()
java.lang.String	name() Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).
java.lang.Long	size()
java.lang.String	title() Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.
java.lang.String	uri()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Resource

public Resource(java.lang.String uri,
                java.lang.String name,
                java.lang.String title,
                java.lang.String description,
                java.lang.String mimeType,
                java.lang.Long size,
                McpSchema.Annotations annotations,
                java.util.Map<java.lang.String,java.lang.Object> meta)

参数:

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

Resource

@Deprecated
public Resource(java.lang.String uri,
                            java.lang.String name,
                            java.lang.String title,
                            java.lang.String description,
                            java.lang.String mimeType,
                            java.lang.Long size,
                            McpSchema.Annotations annotations)

已过时。 Only exists for backwards-compatibility purposes. Use builder() instead.

Resource

@Deprecated
public Resource(java.lang.String uri,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.String mimeType,
                            java.lang.Long size,
                            McpSchema.Annotations annotations)

已过时。 Only exists for backwards-compatibility purposes. Use builder() instead.

Resource

@Deprecated
public Resource(java.lang.String uri,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.String mimeType,
                            McpSchema.Annotations annotations)

已过时。 Only exists for backwards-compatibility purposes. Use builder() instead.

方法详细资料

uri

public java.lang.String uri()

指定者:

uri 在接口中 McpSchema.ResourceContent

name

public java.lang.String name()

从接口复制的说明: McpSchema.Identifier

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).

指定者:

name 在接口中 McpSchema.Identifier

title

public java.lang.String title()

从接口复制的说明: McpSchema.Identifier

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology. If not provided, the name should be used for display.

指定者:

title 在接口中 McpSchema.Identifier

description

public java.lang.String description()

指定者:

description 在接口中 McpSchema.ResourceContent

mimeType

public java.lang.String mimeType()

指定者:

mimeType 在接口中 McpSchema.ResourceContent

size

public java.lang.Long size()

指定者:

size 在接口中 McpSchema.ResourceContent

annotations

public McpSchema.Annotations annotations()

指定者:

annotations 在接口中 McpSchema.Annotated

meta

public java.util.Map<java.lang.String,java.lang.Object> meta()

指定者:

meta 在接口中 McpSchema.Meta

返回:

additional metadata related to this resource.

另请参阅:

Specification for notes on _meta usage

builder

public static McpSchema.Resource.Builder builder()