Package dev.tachyonmcp.api.server.features.tools

Interface ToolDescriptor.Builder

Enclosing interface:

ToolDescriptor

public static interface ToolDescriptor.Builder

Builder for ToolDescriptor.

Method Summary

Modifier and Type	Method	Description
ToolDescriptor.Builder	annotations(@Nullable ToolAnnotations annotations)	Sets the optional behavioral annotations (e.g. read-only, destructive) for this tool.
ToolDescriptor	build()	Builds the ToolDescriptor.
ToolDescriptor.Builder	description(@Nullable String description)	Sets the optional description of this tool.
ToolDescriptor.Builder	extensionId(@Nullable String extensionId)	Sets the optional identifier of the extension that owns this tool.
default ToolDescriptor.Builder	icons(Icon... icons)	Sets the optional icons for this tool.
ToolDescriptor.Builder	icons(@Nullable Iterable<? extends Icon> icons)	Sets the optional icons for this tool.
ToolDescriptor.Builder	inputSchema(@Nullable JsonSchema inputSchema)	Sets the optional JSON schema describing the tool's input arguments.
default ToolDescriptor.Builder	inputSchema(@Nullable String inputSchema)	Sets the optional JSON schema describing the tool's input arguments, parsed from a string.
ToolDescriptor.Builder	meta(@Nullable Map<String,?> entries)	Sets optional protocol extension metadata.
ToolDescriptor.Builder	name(String name)	Sets the tool name, unique within the server.
ToolDescriptor.Builder	outputSchema(@Nullable JsonSchema outputSchema)	Sets the optional JSON schema describing the tool's output.
default ToolDescriptor.Builder	outputSchema(@Nullable String outputSchema)	Sets the optional JSON schema describing the tool's output, parsed from a string.
ToolDescriptor.Builder	taskSupport(@Nullable TaskSupport taskSupport)	Sets the optional declaration of this tool's support for long-running tasks.
ToolDescriptor.Builder	title(@Nullable String title)	Sets the optional human-readable title.

Method Details

name

ToolDescriptor.Builder name(String name)

Sets the tool name, unique within the server.

title

ToolDescriptor.Builder title(@Nullable String title)

Sets the optional human-readable title.

description

ToolDescriptor.Builder description(@Nullable String description)

Sets the optional description of this tool.

inputSchema

ToolDescriptor.Builder inputSchema(@Nullable JsonSchema inputSchema)

Sets the optional JSON schema describing the tool's input arguments.

outputSchema

ToolDescriptor.Builder outputSchema(@Nullable JsonSchema outputSchema)

Sets the optional JSON schema describing the tool's output.

inputSchema

default ToolDescriptor.Builder inputSchema(@Nullable String inputSchema)

Sets the optional JSON schema describing the tool's input arguments, parsed from a string.

outputSchema

default ToolDescriptor.Builder outputSchema(@Nullable String outputSchema)

Sets the optional JSON schema describing the tool's output, parsed from a string.

taskSupport

ToolDescriptor.Builder taskSupport(@Nullable TaskSupport taskSupport)

Sets the optional declaration of this tool's support for long-running tasks.

annotations

ToolDescriptor.Builder annotations(@Nullable ToolAnnotations annotations)

Sets the optional behavioral annotations (e.g. read-only, destructive) for this tool.

icons

ToolDescriptor.Builder icons(@Nullable Iterable<? extends Icon> icons)

Sets the optional icons for this tool.

icons

default ToolDescriptor.Builder icons(Icon... icons)

Sets the optional icons for this tool.

extensionId

ToolDescriptor.Builder extensionId(@Nullable String extensionId)

Sets the optional identifier of the extension that owns this tool.

meta

ToolDescriptor.Builder meta(@Nullable Map<String,?> entries)

Sets optional protocol extension metadata.

Parameters:

entries - metadata entries, or null for none

build

ToolDescriptor build()

Builds the ToolDescriptor.