Package org.apache.juneau.bean.mcp.v20260728

Class CreateMessageRequest

java.lang.Object
org.apache.juneau.bean.mcp.v20260728.CreateMessageRequest
@Marshalled public class CreateMessageRequest extends Object
Parameters for "sampling/createMessage", a server-to-client duplex request (MCP sampling). Never dispatched through McpRevision — this is a plain POJO decoded/encoded by hand (or via the client's typed duplex flow) inside an McpServerRequestHandler implementation.

  • Constructor Details

  • Method Details

    • getMessages

      public List<SamplingMessage> getMessages()
      The conversation history to sample from.
      Returns:
      The messages list, or null if not set.

    • setMessages

      public CreateMessageRequest setMessages(List<SamplingMessage> value)
      Sets the messages.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • setMessages

      public CreateMessageRequest setMessages(SamplingMessage... value)
      Sets the messages.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • addMessages

      public CreateMessageRequest addMessages(SamplingMessage... value)
      Appends to the messages.
      Parameters:
      value - The values to append.
      Returns:
      This object (for method chaining).

    • addMessages

      public CreateMessageRequest addMessages(Collection<SamplingMessage> value)
      Appends to the messages.
      Parameters:
      value - The values to append.
      Returns:
      This object (for method chaining).

    • getModelPreferences

      public ModelPreferences getModelPreferences()
      Model-selection preferences.
      Returns:
      The preferences, or null if not set.

    • setModelPreferences

      public CreateMessageRequest setModelPreferences(ModelPreferences value)
      Sets the model preferences.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • getSystemPrompt

      public String getSystemPrompt()
      An optional system prompt.
      Returns:
      The system prompt, or null if not set.

    • setSystemPrompt

      public CreateMessageRequest setSystemPrompt(String value)
      Sets the system prompt.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • getIncludeContext

      public String getIncludeContext()
      Which MCP context to include (none/thisServer/allServers per the pinned schema). Kept as a plain String, matching this module's existing precedent of not over-modeling schema string-enums that do not gate real branching logic in this codebase.
      Returns:
      The include-context value, or null if not set.

    • setIncludeContext

      public CreateMessageRequest setIncludeContext(String value)
      Sets the include-context value.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • getTemperature

      public Double getTemperature()
      Sampling temperature.
      Returns:
      The temperature, or null if not set.

    • setTemperature

      public CreateMessageRequest setTemperature(Double value)
      Sets the temperature.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • getMaxTokens

      public Integer getMaxTokens()
      Maximum tokens to sample.
      Returns:
      The max tokens, or null if not set.

    • setMaxTokens

      public CreateMessageRequest setMaxTokens(Integer value)
      Sets the max tokens.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • getStopSequences

      public List<String> getStopSequences()
      Sequences that stop sampling when generated.
      Returns:
      The stop sequences, or null if not set.

    • setStopSequences

      public CreateMessageRequest setStopSequences(List<String> value)
      Sets the stop sequences.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • setStopSequences

      public CreateMessageRequest setStopSequences(String... value)
      Sets the stop sequences.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • addStopSequences

      public CreateMessageRequest addStopSequences(String... value)
      Appends to the stop sequences.
      Parameters:
      value - The values to append.
      Returns:
      This object (for method chaining).

    • addStopSequences

      public CreateMessageRequest addStopSequences(Collection<String> value)
      Appends to the stop sequences.
      Parameters:
      value - The values to append.
      Returns:
      This object (for method chaining).

    • getMetadata

      public Map<String,Object> getMetadata()
      Free-form server-defined metadata.
      Returns:
      The metadata map, or null if not set.

    • setMetadata

      public CreateMessageRequest setMetadata(Map<String,Object> value)
      Sets the metadata.
      Parameters:
      value - The new value. Can be null to unset the property.
      Returns:
      This object (for method chaining).

    • putMetadata

      public CreateMessageRequest putMetadata(String name, Object value)
      Convenience method to add a single metadata entry.
      Parameters:
      name - The entry name. Can be null (LinkedHashMap tolerates a null key).
      value - The entry value. Can be null (stored as null).
      Returns:
      This object (for method chaining).