Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.JsonSchema

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.JsonSchema

Record Components:

type - The type of the schema (e.g., "object")

properties - The properties of the schema object

required - List of required property names

additionalProperties - Whether additional properties are allowed

defs - Schema definitions using the newer $defs keyword

definitions - Schema definitions using the legacy definitions keyword

Enclosing class:

McpSchema

public static record McpSchema.JsonSchema(String type, Map<String,Object> properties, List<String> required, Boolean additionalProperties, Map<String,Object> defs, Map<String,Object> definitions)
extends Record

A JSON Schema object that describes the expected structure of arguments or output.

Constructor Summary

Constructors

Constructor	Description
JsonSchema(String type, Map<String,Object> properties, List<String> required, Boolean additionalProperties, Map<String,Object> defs, Map<String,Object> definitions)	Creates an instance of a JsonSchema record class.

Method Summary

Modifier and Type	Method	Description
Boolean	additionalProperties()	Returns the value of the additionalProperties record component.
Map<String,Object>	definitions()	Returns the value of the definitions record component.
Map<String,Object>	defs()	Returns the value of the defs 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.
Map<String,Object>	properties()	Returns the value of the properties record component.
List<String>	required()	Returns the value of the required record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonSchema

public JsonSchema(String type,
 Map<String,Object> properties,
 List<String> required,
 Boolean additionalProperties,
 Map<String,Object> defs,
 Map<String,Object> definitions)

Creates an instance of a JsonSchema record class.

Parameters:

type - the value for the type record component

properties - the value for the properties record component

required - the value for the required record component

additionalProperties - the value for the additionalProperties record component

defs - the value for the defs record component

definitions - the value for the definitions 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.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

properties

public Map<String,Object> properties()

Returns the value of the properties record component.

Returns:

the value of the properties record component

required

public List<String> required()

Returns the value of the required record component.

Returns:

the value of the required record component

additionalProperties

public Boolean additionalProperties()

Returns the value of the additionalProperties record component.

Returns:

the value of the additionalProperties record component

defs

public Map<String,Object> defs()

Returns the value of the defs record component.

Returns:

the value of the defs record component

definitions

public Map<String,Object> definitions()

Returns the value of the definitions record component.

Returns:

the value of the definitions record component