Class McpTool<I>

java.lang.Object

net.mcreator.io.mcp.tool.McpTool<I>

Type Parameters:

I - input type used for JSON Schema generation and argument deserialization

All Implemented Interfaces:

IMcpTool

Direct Known Subclasses:

MCreatorMcpTool

public abstract class McpTool<I>
extends Object
implements IMcpTool

Base class for MCP tools with a typed input model. Subclass to add tool-specific APIs (e.g. actionable interfaces) alongside call(I).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	McpTool(Class<I> inputType)
protected	McpTool(Class<I> inputType, Class<?> outputType)

Method Summary

Modifier and Type	Method	Description
protected abstract CompletableFuture<ToolResult>	call(I input)	Handles a tool invocation with deserialized, typed arguments.
protected static CompletableFuture<ToolResult>	completed(ToolResult result)
protected static CompletableFuture<ToolResult>	completedError(String message)
protected static CompletableFuture<ToolResult>	completedError(String message, Throwable cause)
protected static CompletableFuture<ToolResult>	completedObject(Object structured)
protected static CompletableFuture<ToolResult>	completedText(String text)
McpSchema.ToolAnnotations	getAnnotations()
Class<I>	getInputType()
Class<?>	getOutputType()
final CompletableFuture<McpSchema.CallToolResponse>	invoke(com.google.gson.JsonObject arguments)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IMcpTool

getDescription, getName

Constructor Details

McpTool

protected McpTool(Class<I> inputType)

McpTool

protected McpTool(Class<I> inputType,
 Class<?> outputType)

Method Details

getInputType

public Class<I> getInputType()

Specified by:

getInputType in interface IMcpTool

getOutputType

public Class<?> getOutputType()

Specified by:

getOutputType in interface IMcpTool

getAnnotations

public McpSchema.ToolAnnotations getAnnotations()

Specified by:

getAnnotations in interface IMcpTool

invoke

public final CompletableFuture<McpSchema.CallToolResponse> invoke(com.google.gson.JsonObject arguments)

Specified by:

invoke in interface IMcpTool

call

protected abstract CompletableFuture<ToolResult> call(I input)

Handles a tool invocation with deserialized, typed arguments.

completed

protected static CompletableFuture<ToolResult> completed(ToolResult result)

completedText

protected static CompletableFuture<ToolResult> completedText(String text)

completedError

protected static CompletableFuture<ToolResult> completedError(String message)

completedError

protected static CompletableFuture<ToolResult> completedError(String message,
 Throwable cause)

completedObject

protected static CompletableFuture<ToolResult> completedObject(Object structured)