Annotation Interface McpPrompt

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

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Declares the human-readable prompt description.
    String
    name
    Declares the MCP prompt name.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    @Nullable String
    title
    Declares optional prompt title metadata for clients that display a separate title.

  • Element Details

    • name

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

    • description

      String description
      Declares the human-readable prompt description.
      Returns:
      the prompt description

    • title

      @Nullable String title
      Declares optional prompt title metadata for clients that display a separate title.
      Returns:
      the prompt title, or an empty string if unspecified
      Default:
      ""