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. Per SEP-1613, the dialect defaults to JSON Schema 2020-12 (McpSchema.JSON_SCHEMA_DIALECT_2020_12) when no explicit $schema entry is present. To declare a different dialect, include a "$schema" key in the map. For tools with no parameters the spec recommends {"type":"object","additionalProperties":false}.

outputSchema - An optional JSON Schema object defining the structure of the tool's output returned in the structuredContent field of a CallToolResult. Same dialect rules as inputSchema.

annotations - Optional additional tool information.

icons - Optional list of icons for this tool.

meta - See specification for notes on _meta usage

Enclosing class:

McpSchema

public static record McpSchema.Tool(String name, String title, String description, Map<String,Object> inputSchema, Map<String,Object> outputSchema, McpSchema.ToolAnnotations annotations, Map<String,Object> meta, List<McpSchema.Icon> icons)
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.Tool.Builder

Constructor Summary

Constructors

Constructor	Description
Tool(String name, String title, String description, Map<String,Object> inputSchema, Map<String,Object> outputSchema, McpSchema.ToolAnnotations annotations, Map<String,Object> meta)	Deprecated. Use builder(String, Map)
Tool(String name, String title, String description, Map<String,Object> inputSchema, Map<String,Object> outputSchema, McpSchema.ToolAnnotations annotations, Map<String,Object> meta, List<McpSchema.Icon> icons)	Creates an instance of a Tool record class.

Method Summary

Modifier and Type	Method	Description
McpSchema.ToolAnnotations	annotations()	Returns the value of the annotations record component.
static McpSchema.Tool.Builder	builder()	Deprecated. Use builder(String, Map) instead.
static McpSchema.Tool.Builder	builder(String name)	Deprecated.
static McpSchema.Tool.Builder	builder(String name, McpJsonMapper jsonMapper, String inputSchema)
static McpSchema.Tool.Builder	builder(String name, Map<String,Object> inputSchema)
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.
List<McpSchema.Icon>	icons()	Returns the value of the icons record component.
Map<String,Object>	inputSchema()	Returns the value of the inputSchema record component.
Map<String,Object>	meta()	Returns the value of the meta record component.
String	name()	Returns the value of the name record component.
Map<String,Object>	outputSchema()	Returns the value of the outputSchema record component.
String	title()	Returns the value of the title 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

Tool

public Tool(String name,
 String title,
 String description,
 Map<String,Object> inputSchema,
 Map<String,Object> outputSchema,
 McpSchema.ToolAnnotations annotations,
 Map<String,Object> meta,
 List<McpSchema.Icon> icons)

Creates an instance of a Tool record class.

Parameters:

name - the value for the name record component

title - the value for the title record component

description - the value for the description record component

inputSchema - the value for the inputSchema record component

outputSchema - the value for the outputSchema record component

annotations - the value for the annotations record component

meta - the value for the meta record component

icons - the value for the icons record component

Tool

@Deprecated
public Tool(String name,
 String title,
 String description,
 Map<String,Object> inputSchema,
 Map<String,Object> outputSchema,
 McpSchema.ToolAnnotations annotations,
 Map<String,Object> meta)

Deprecated.

Use builder(String, Map)

Method Details

builder

@Deprecated
public static McpSchema.Tool.Builder builder()

Deprecated.

Use builder(String, Map) instead.

builder

@Deprecated
public static McpSchema.Tool.Builder builder(String name)

Deprecated.

Uses empty input schema.

Parameters:

name -

Returns:

builder

public static McpSchema.Tool.Builder builder(String name,
 Map<String,Object> inputSchema)

builder

public static McpSchema.Tool.Builder builder(String name,
 McpJsonMapper jsonMapper,
 String inputSchema)

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 Map<String,Object> 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

icons

public List<McpSchema.Icon> icons()

Returns the value of the icons record component.

Returns:

the value of the icons record component