Package io.quarkiverse.mcp.server

Annotation Interface CompleteResourceTemplate

@Retention(RUNTIME) @Target(METHOD) public @interface CompleteResourceTemplate
Annotates a business method of a CDI bean used to complete an expression of a URI template of a resource template.

The result of a "complete" operation is always represented as a CompletionResponse. However, the annotated method can also return other types that are converted according to the following rules.

  • If the method returns String then the response contains the single value.
  • If the method returns a List of Strings then the response contains the list of values.
  • The method may return a Uni that wraps any of the type mentioned above.
In other words, the return type must be one of the following list:
  • CompletionResponse
  • String
  • List<String>
  • Uni<CompletionResponse>
  • Uni<String>
  • Uni<List<String>>
A resource template completion method must consume exactly one String argument.
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    The name reference to a resource template.

  • Element Details

    • value

      String value
      The name reference to a resource template. If not such ResourceTemplate exists then the build fails.