Class AbstractMcpTool<T>

java.lang.Object

com.google.adk.tools.BaseTool

com.google.adk.tools.mcp.AbstractMcpTool<T>

Type Parameters:

T - The type of the MCP session client.

Direct Known Subclasses:

McpAsyncTool, McpTool

public abstract class AbstractMcpTool<T>
extends BaseTool

Base class for MCP tools.

Nested Class Summary

Nested classes/interfaces inherited from class BaseTool

BaseTool.ToolArgsConfig, BaseTool.ToolConfig

Modifier and Type	Class	Description
static class	BaseTool.ToolArgsConfig	Configuration class for tool arguments that allows arbitrary key-value pairs.
static class	BaseTool.ToolConfig	Configuration class for a tool definition in YAML/JSON.

Field Summary

Fields

Modifier and Type	Field	Description
protected T	mcpSession
protected final McpSessionManager	mcpSessionManager
protected final io.modelcontextprotocol.spec.McpSchema.Tool	mcpTool
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMcpTool(io.modelcontextprotocol.spec.McpSchema.Tool mcpTool, T mcpSession, McpSessionManager mcpSessionManager, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
io.modelcontextprotocol.spec.McpSchema.ToolAnnotations	annotations()
Optional<com.google.genai.types.FunctionDeclaration>	declaration()	Gets the FunctionDeclaration representation of this tool.
T	getMcpSession()
Map<String,Object>	meta()
protected static Map<String,Object>	wrapCallResult(com.fasterxml.jackson.databind.ObjectMapper objectMapper, String mcpToolName, io.modelcontextprotocol.spec.McpSchema.CallToolResult callResult)

Methods inherited from class BaseTool

customMetadata, description, fromConfig, longRunning, name, processLlmRequest, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, setCustomMetadata

Modifier and Type	Method	Description
com.google.common.collect.ImmutableMap<String,Object>	customMetadata()	Returns a read-only view of the tool metadata.
String	description()
static BaseTool	fromConfig(BaseTool.ToolConfig config, String configAbsPath)	Creates a tool instance from a config.
boolean	longRunning()
String	name()
io.reactivex.rxjava3.core.Completable	processLlmRequest(LlmRequest.Builder llmRequestBuilder, ToolContext toolContext)	Processes the outgoing LlmRequest.Builder.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, com.fasterxml.jackson.core.type.TypeReference<? extends O> typeReference)	Calls a tool with generic arguments, returning the results converted to a specified type reference.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.core.type.TypeReference<? extends O> typeReference)	Calls a tool with generic arguments and a custom ObjectMapper, returning the results converted to a specified type reference.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Class<? extends O> oClass)	Calls a tool with generic arguments and a custom ObjectMapper, returning the results converted to a specified class.
final <I,O> io.reactivex.rxjava3.core.Single<O>	runAsync(I args, ToolContext toolContext, Class<? extends O> oClass)	Calls a tool with generic arguments, returning the results converted to a specified class.
io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(Map<String,Object> args, ToolContext toolContext)	Calls a tool.
final <T> io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(T args, ToolContext toolContext)	Calls a tool with generic arguments and returns a map of results.
final <T> io.reactivex.rxjava3.core.Single<Map<String,Object>>	runAsync(T args, ToolContext toolContext, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Calls a tool with generic arguments using a custom ObjectMapper and returns a map of results.
void	setCustomMetadata(String key, Object value)	Sets custom metadata to the tool associated with a key.

Methods inherited from class Object

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

Field Details

mcpTool

protected final io.modelcontextprotocol.spec.McpSchema.Tool mcpTool

mcpSessionManager

protected final McpSessionManager mcpSessionManager

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

mcpSession

protected volatile T mcpSession

Constructor Details

AbstractMcpTool

protected AbstractMcpTool(io.modelcontextprotocol.spec.McpSchema.Tool mcpTool,
 T mcpSession,
 McpSessionManager mcpSessionManager,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

annotations

public io.modelcontextprotocol.spec.McpSchema.ToolAnnotations annotations()

meta

public Map<String,Object> meta()

getMcpSession

public T getMcpSession()

declaration

public Optional<com.google.genai.types.FunctionDeclaration> declaration()

Description copied from class: BaseTool

Gets the FunctionDeclaration representation of this tool.

Overrides:

declaration in class BaseTool

wrapCallResult

protected static Map<String,Object> wrapCallResult(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 String mcpToolName,
 io.modelcontextprotocol.spec.McpSchema.CallToolResult callResult)