Record Class McpToolInfo

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.ai.McpToolInfo
Record Components:
name - the tool name as advertised by the server (unprefixed). The harness-visible name is mcp__<serverName>__<name>.
description - the tool's description as advertised by the server; empty string when the server didn't provide one.

public record McpToolInfo(String name, String description) extends Record
Read-only snapshot of one tool advertised by an MCP connection. Consumed by inventory routes that feed the user-agent configuration UI so operators can see which tools an agent will inherit when it attaches a connection — the picker doesn't offer per-tool selection (attach is all-or-nothing at the connection level), but seeing the tool set is useful when debugging why an agent chose to call a particular tool.
  • Constructor Details

    • McpToolInfo

      public McpToolInfo(String name, String description)
      Creates an instance of a McpToolInfo record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description 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.
    • 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