Annotation Interface McpResource

@Target(METHOD) @Retention(RUNTIME) public @interface McpResource
Applies to methods that expose an MCP resource.
Author:
Mark Allen

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    mimeType
    Declares the MIME type returned by the resource-read handler.
    String
    name
    Declares the MCP resource name.
    String
    uri
    Declares the resource URI or URI template.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    @Nullable String
    description
    Declares optional resource description metadata.

  • Element Details

    • uri

      String uri
      Declares the resource URI or URI template.
      Returns:
      the resource URI or URI template

    • name

      String name
      Declares the MCP resource name.
      Returns:
      the resource name exposed to clients

    • mimeType

      String mimeType
      Declares the MIME type returned by the resource-read handler.
      Returns:
      the resource MIME type

    • description

      @Nullable String description
      Declares optional resource description metadata.
      Returns:
      the resource description, or an empty string if unspecified
      Default:
      ""