Package org.springframework.ai.tool.metadata

Interface ToolMetadata

All Known Implementing Classes:

DefaultToolMetadata

public interface ToolMetadata

Metadata about a tool specification and execution.

Since:

1.0.0

Author:

Thomas Vitale

Method Summary

Modifier and Type	Method	Description
static DefaultToolMetadata.Builder	builder()	Create a default ToolMetadata builder.
static ToolMetadata	from(Method method)	Create a default ToolMetadata instance from a Method.
default boolean	requiresConfirmation()	Whether a call of the tool needs a person's confirmation before it runs.
default boolean	returnDirect()	Whether the tool result should be returned directly or passed back to the model.

Method Details

returnDirect

default boolean returnDirect()

Whether the tool result should be returned directly or passed back to the model.

requiresConfirmation

default boolean requiresConfirmation()

Whether a call of the tool needs a person's confirmation before it runs. DefaultToolCallingManager refuses to run such a call without a decision, and the tool-calling loop pauses on it; see ToolCallDecisions. A custom ToolCallingManager has to check it itself.

Since:

2.1.0

builder

static DefaultToolMetadata.Builder builder()

Create a default ToolMetadata builder.

from

static ToolMetadata from(Method method)

Create a default ToolMetadata instance from a Method.