Package org.springframework.ai.mcp.annotation

Annotation Interface McpIcon

@Documented
@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
public @interface McpIcon

An icon of a tool, resource or prompt, published in its definition so that clients can render it. Used inside McpTool.icons(), McpResource.icons() and McpPrompt.icons().

Since:

2.1.0

Author:

Christian Tzolov

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	src	The icon location: an https:// URL or a data: URI.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	mimeType	Optional MIME type, for example image/png or image/svg+xml.
String[]	sizes	Optional size hints such as "48x48", or "any" for scalable icons.
String	theme	Optional theme the icon is designed for: "light" or "dark".

Element Details

src

String src

The icon location: an https:// URL or a data: URI.

mimeType

String mimeType

Optional MIME type, for example image/png or image/svg+xml.

Default:

""

sizes

String[] sizes

Optional size hints such as "48x48", or "any" for scalable icons.

Default:

{}

theme

String theme

Optional theme the icon is designed for: "light" or "dark".

Default:

""