Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.spec

Record Class McpSchema.ToolAnnotations

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.ToolAnnotations
Enclosing class:
McpSchema
public static record McpSchema.ToolAnnotations(String title, Boolean readOnlyHint, Boolean destructiveHint, Boolean idempotentHint, Boolean openWorldHint, Boolean returnDirect) extends Record
Additional properties describing a Tool to clients. NOTE: all properties in ToolAnnotations are **hints**. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like `title`). Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers.

  • Constructor Details

    • ToolAnnotations

      public ToolAnnotations(String title, Boolean readOnlyHint, Boolean destructiveHint, Boolean idempotentHint, Boolean openWorldHint, Boolean returnDirect)
      Creates an instance of a ToolAnnotations record class.
      Parameters:
      title - the value for the title record component
      readOnlyHint - the value for the readOnlyHint record component
      destructiveHint - the value for the destructiveHint record component
      idempotentHint - the value for the idempotentHint record component
      openWorldHint - the value for the openWorldHint record component
      returnDirect - the value for the returnDirect 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • title

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

    • readOnlyHint

      public Boolean readOnlyHint()
      Returns the value of the readOnlyHint record component.
      Returns:
      the value of the readOnlyHint record component

    • destructiveHint

      public Boolean destructiveHint()
      Returns the value of the destructiveHint record component.
      Returns:
      the value of the destructiveHint record component

    • idempotentHint

      public Boolean idempotentHint()
      Returns the value of the idempotentHint record component.
      Returns:
      the value of the idempotentHint record component

    • openWorldHint

      public Boolean openWorldHint()
      Returns the value of the openWorldHint record component.
      Returns:
      the value of the openWorldHint record component

    • returnDirect

      public Boolean returnDirect()
      Returns the value of the returnDirect record component.
      Returns:
      the value of the returnDirect record component