Package org.springframework.ai.mcp.annotation

Annotation Interface McpPrompt

@Target({METHOD,ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented public @interface McpPrompt
Marks a method as a MCP Prompt.
Author:
Christian Tzolov, Vadzim Shurmialiou, Craig Walls

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Optional human-readable description.
    Class<? extends MetaProvider>
    metaProvider
    Optional meta provider class that implements the MetaProvider interface.
    String
    name
    Unique identifier for the prompt
    String
    title
    Optional human-readable name of the prompt for display purposes.

  • Element Details

    • name

      String name
      Unique identifier for the prompt
      Default:
      ""

    • title

      String title
      Optional human-readable name of the prompt for display purposes.
      Default:
      ""

    • description

      String description
      Optional human-readable description.
      Default:
      ""

    • metaProvider

      Class<? extends MetaProvider> metaProvider
      Optional meta provider class that implements the MetaProvider interface. Used to provide additional metadata for the prompt. Defaults to DefaultMetaProvider.class if not specified.
      Default:
      org.springframework.ai.mcp.annotation.context.DefaultMetaProvider.class