Package org.mcpjava.server.completion

Annotation Interface CompleteArg

@Target(PARAMETER) @Retention(RUNTIME) @Documented public @interface CompleteArg
Customizes the name of a completed argument in a completion method.

A completion method must consume exactly one String argument representing the partial value that needs to be completed.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    The name of the completed argument.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT_NAME
    Constant value for name() indicating that the annotated element's name should be used as-is.

  • Field Details

    • ELEMENT_NAME

      static final String ELEMENT_NAME
      Constant value for name() indicating that the annotated element's name should be used as-is.
      See Also:

  • Element Details

    • name

      String name
      The name of the completed argument.

      By default, the parameter name from the method signature will be used (requires compilation with the -parameters flag).

      Returns:
      the argument name
      Default:
      "<<element name>>"