Package com.commercetools.api.models.mcp_server

Interface ParameterOverride

public interface ParameterOverride

Override applied to a single parameter of a tool's input schema. At least one of description, const, default, or allowedTypes must be present. const is mutually exclusive with both default and allowedTypes. Parameter values are JSON values.

Example to create an instance using the builder pattern 

     ParameterOverride parameterOverride = ParameterOverride.builder()
             .name("{name}")
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the parameter in the tool's input schema to override.

      Returns:
      name

    • getDescription

      String getDescription()

      Replacement description for the parameter, shown to the AI agent.

      Returns:
      description

    • getConst

      Object getConst()

      Pins the parameter to a fixed value. Mutually exclusive with default and allowedTypes.

      Returns:
      const

    • getDefault

      Object getDefault()

      Default value applied when the caller omits the parameter. Mutually exclusive with const.

      Returns:
      default

    • getAllowedTypes

      List<Object> getAllowedTypes()

      Restricts accepted values to this set. Mutually exclusive with const.

      Returns:
      allowedTypes

    • setName

      void setName(String name)

      Name of the parameter in the tool's input schema to override.

      Parameters:
      name - value to be set

    • setDescription

      void setDescription(String description)

      Replacement description for the parameter, shown to the AI agent.

      Parameters:
      description - value to be set

    • setConst

      void setConst(Object _const)

      Pins the parameter to a fixed value. Mutually exclusive with default and allowedTypes.

      Parameters:
      _const - value to be set

    • setDefault

      void setDefault(Object _default)

      Default value applied when the caller omits the parameter. Mutually exclusive with const.

      Parameters:
      _default - value to be set

    • setAllowedTypes

      void setAllowedTypes(Object... allowedTypes)

      Restricts accepted values to this set. Mutually exclusive with const.

      Parameters:
      allowedTypes - values to be set

    • setAllowedTypes

      void setAllowedTypes(List<Object> allowedTypes)

      Restricts accepted values to this set. Mutually exclusive with const.

      Parameters:
      allowedTypes - values to be set

    • of

      static ParameterOverride of()
      factory method
      Returns:
      instance of ParameterOverride

    • of

      static ParameterOverride of(ParameterOverride template)
      factory method to create a shallow copy ParameterOverride
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ParameterOverride copyDeep()

    • deepCopy

      @Nullable static ParameterOverride deepCopy(@Nullable ParameterOverride template)
      factory method to create a deep copy of ParameterOverride
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ParameterOverrideBuilder builder()
      builder factory method for ParameterOverride
      Returns:
      builder

    • builder

      static ParameterOverrideBuilder builder(ParameterOverride template)
      create builder for ParameterOverride instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withParameterOverride

      default <T> T withParameterOverride(Function<ParameterOverride,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<ParameterOverride> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference