Package dev.langchain4j.mcp.client

Record Class McpPromptArgument

java.lang.Object
java.lang.Record
dev.langchain4j.mcp.client.McpPromptArgument
public record McpPromptArgument(String name, String description, boolean required) extends Record
The 'PromptArgument' object from the MCP protocol schema.

  • Constructor Summary

    Constructors
    Constructor
    Description
    McpPromptArgument(String name, String description, boolean required)
    Creates an instance of a McpPromptArgument record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    boolean
    required()
    Returns the value of the required record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • McpPromptArgument

      public McpPromptArgument(String name, String description, boolean required)
      Creates an instance of a McpPromptArgument record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      required - the value for the required record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component