Package io.modelcontextprotocol.spec

Record Class McpSchema.Tool

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.Tool
Record Components:
name - A unique identifier for the tool. This name is used when calling the tool.
title - A human-readable title for the tool.
description - A human-readable description of what the tool does. This can be used by clients to improve the LLM's understanding of available tools.
inputSchema - A JSON Schema object that describes the expected structure of the arguments when calling this tool. This allows clients to validate tool
outputSchema - An optional JSON Schema object defining the structure of the tool's output returned in the structuredContent field of a CallToolResult.
annotations - Optional additional tool information.
meta - See specification for notes on _meta usage
Enclosing class:
McpSchema
public static record McpSchema.Tool(String name, String title, String description, McpSchema.JsonSchema inputSchema, Map<String,Object> outputSchema, McpSchema.ToolAnnotations annotations, Map<String,Object> meta) extends Record
Represents a tool that the server provides. Tools enable servers to expose executable functionality to the system. Through these tools, you can interact with external systems, perform computations, and take actions in the real world.

  • Constructor Details

  • Method Details

    • builder

      public static McpSchema.Tool.Builder builder()

    • 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

    • title

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

    • description

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

    • inputSchema

      public McpSchema.JsonSchema inputSchema()
      Returns the value of the inputSchema record component.
      Returns:
      the value of the inputSchema record component

    • outputSchema

      public Map<String,Object> outputSchema()
      Returns the value of the outputSchema record component.
      Returns:
      the value of the outputSchema record component

    • annotations

      public McpSchema.ToolAnnotations annotations()
      Returns the value of the annotations record component.
      Returns:
      the value of the annotations record component

    • meta

      public Map<String,Object> meta()
      Returns the value of the meta record component.
      Returns:
      the value of the meta record component