Package org.springframework.ai.mcp.annotation

Annotation Interface McpResource

@Target({METHOD,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
public @interface McpResource

Marks a method as a MCP Resource.

Author:

Christian Tzolov, Alexandros Pappas, Vadzim Shurmialiou, Craig Walls

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	McpResource.McpAnnotations

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
McpResource.McpAnnotations	annotations	Optional annotations for the client.
String	description	A description of what this resource represents.
Class<? extends MetaProvider>	metaProvider	Optional meta provider class that supplies data for "_meta" field for this resource declaration.
String	mimeType	The MIME type of this resource, if known.
String	name	Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).
String	title	Optional human-readable name of the prompt for display purposes.
String	uri	the URI of the resource.

Element Details

name

String name

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

Default:

""

title

String title

Optional human-readable name of the prompt for display purposes.

Default:

""

uri

String uri

the URI of the resource.

Default:

""

description

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

Default:

""

mimeType

String mimeType

The MIME type of this resource, if known.

Default:

"text/plain"

annotations

McpResource.McpAnnotations annotations

Optional annotations for the client. Note: The default annotations value is ignored.

Default:

@org.springframework.ai.mcp.annotation.McpResource.McpAnnotations(audience={USER}, lastModified="", priority=0.5)

metaProvider

Class<? extends MetaProvider> metaProvider

Optional meta provider class that supplies data for "_meta" field for this resource declaration. Defaults to DefaultMetaProvider implementation.

Returns:

the meta provider class to use for this resource

Default:

org.springframework.ai.mcp.annotation.context.DefaultMetaProvider.class