Files
2026-09-13 21:55:56 +00:00

417 lines
38 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Google Analytics tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-DKHZS27PHP"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag("js", new Date());
gtag("config", "G-DKHZS27PHP");
</script>
<!-- Generated by javadoc (26) -->
<title>McpAsyncTool (Google Agent Development Kit Maven Parent POM 1.7.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: com.google.adk.tools.mcp, class: McpAsyncTool">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="../../../../../resource-files/jquery-ui.min.css">
<link rel="stylesheet" type="text/css" href="../../../../../resource-files/stylesheet.css">
<script type="text/javascript" src="../../../../../script-files/script.js"></script>
<script type="text/javascript" src="../../../../../script-files/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-files/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">const pathtoroot = "../../../../../";
loadScripts();
initTheme();
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="nav-content">
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/McpAsyncTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../search.html">Search</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"></button></li>
</ul>
<div id="theme-panel">
<div>Select Theme</div>
<div><label for="theme-light"><input type="radio" id="theme-light" disabled name="theme" value="theme-light"><span>Light</span></label><label for="theme-dark"><input type="radio" id="theme-dark" disabled name="theme" value="theme-dark"><span>Dark</span></label><label for="theme-os"><input type="radio" id="theme-os" disabled name="theme" value="theme-os"><span>System Setting</span></label></div>
</div>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="package-summary.html">com.google.adk.tools.mcp</a></li>
<li><a href="McpAsyncTool.html" class="current-selection">McpAsyncTool</a></li>
</ol>
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="main-grid">
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents&nbsp;<input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset">&nbsp;<button class="toc-sort-toggle" id="toc-lexical-order-toggle"><img src="../../../../../resource-files/sort-a-z.svg" alt="Sort member details in lexicographical order"></button></div>
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li>
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E(io.modelcontextprotocol.spec.McpSchema.Tool,io.modelcontextprotocol.client.McpAsyncClient,com.google.adk.tools.mcp.McpSessionManager)" tabindex="0">McpAsyncTool(McpSchema.Tool, McpAsyncClient, McpSessionManager)</a></li>
<li><a href="#%3Cinit%3E(io.modelcontextprotocol.spec.McpSchema.Tool,io.modelcontextprotocol.client.McpAsyncClient,com.google.adk.tools.mcp.McpSessionManager,com.fasterxml.jackson.databind.ObjectMapper)" tabindex="0">McpAsyncTool(McpSchema.Tool, McpAsyncClient, McpSessionManager, ObjectMapper)</a></li>
</ol>
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#runAsync(java.util.Map,com.google.adk.tools.ToolContext)" tabindex="0">runAsync(Map, ToolContext)</a></li>
</ol>
</li>
</ol>
<button class="hide-sidebar"><span>Hide sidebar&nbsp;</span><img src="../../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../../resource-files/right.svg" alt="Show sidebar"><span>&nbsp;Show sidebar</span></button></nav>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h1 title="Class McpAsyncTool" class="title">Class McpAsyncTool</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../BaseTool.html" title="class in com.google.adk.tools">com.google.adk.tools.BaseTool</a>
<div class="inheritance"><a href="AbstractMcpTool.html" title="class in com.google.adk.tools.mcp">com.google.adk.tools.mcp.AbstractMcpTool</a>&lt;io.modelcontextprotocol.client.McpAsyncClient&gt;
<div class="inheritance">com.google.adk.tools.mcp.McpAsyncTool</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">McpAsyncTool</span>
<span class="extends-implements">extends <a href="AbstractMcpTool.html" title="class in com.google.adk.tools.mcp">AbstractMcpTool</a>&lt;io.modelcontextprotocol.client.McpAsyncClient&gt;</span></div>
<div class="block">Initializes a MCP tool.
<p>This wraps a MCP Tool interface and an active MCP Session. It invokes the MCP Tool through
executing the tool from remote MCP Session.</div>
</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h3 id="nested-classes-inherited-from-class-com.google.adk.tools.BaseTool">Nested classes/interfaces inherited from class&nbsp;<a href="../BaseTool.html#nested-class-summary" title="class in com.google.adk.tools">BaseTool</a></h3>
<code><a href="../BaseTool.ToolArgsConfig.html" title="class in com.google.adk.tools">BaseTool.ToolArgsConfig</a>, <a href="../BaseTool.ToolConfig.html" title="class in com.google.adk.tools">BaseTool.ToolConfig</a></code>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.ToolArgsConfig.html" class="type-name-link" title="class in com.google.adk.tools">BaseTool.ToolArgsConfig</a></code></div>
<div class="col-last even-row-color">
<div class="block">Configuration class for tool arguments that allows arbitrary key-value pairs.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.ToolConfig.html" class="type-name-link" title="class in com.google.adk.tools">BaseTool.ToolConfig</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Configuration class for a tool definition in YAML/JSON.</div>
</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-com.google.adk.tools.mcp.AbstractMcpTool">Fields inherited from class&nbsp;<a href="AbstractMcpTool.html#field-summary" title="class in com.google.adk.tools.mcp">AbstractMcpTool</a></h3>
<code><a href="AbstractMcpTool.html#mcpSession">mcpSession</a>, <a href="AbstractMcpTool.html#mcpSessionManager">mcpSessionManager</a>, <a href="AbstractMcpTool.html#mcpTool">mcpTool</a>, <a href="AbstractMcpTool.html#objectMapper">objectMapper</a></code>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected io.modelcontextprotocol.client.McpAsyncClient</code></div>
<div class="col-second even-row-color"><code><a href="AbstractMcpTool.html#mcpSession" class="member-name-link">mcpSession</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final <a href="McpSessionManager.html" title="class in com.google.adk.tools.mcp">McpSessionManager</a></code></div>
<div class="col-second odd-row-color"><code><a href="AbstractMcpTool.html#mcpSessionManager" class="member-name-link">mcpSessionManager</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected final io.modelcontextprotocol.spec.McpSchema.Tool</code></div>
<div class="col-second even-row-color"><code><a href="AbstractMcpTool.html#mcpTool" class="member-name-link">mcpTool</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final com.fasterxml.jackson.databind.ObjectMapper</code></div>
<div class="col-second odd-row-color"><code><a href="AbstractMcpTool.html#objectMapper" class="member-name-link">objectMapper</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(io.modelcontextprotocol.spec.McpSchema.Tool,io.modelcontextprotocol.client.McpAsyncClient,com.google.adk.tools.mcp.McpSessionManager)" class="member-name-link">McpAsyncTool</a><wbr>(io.modelcontextprotocol.spec.McpSchema.Tool&nbsp;mcpTool,
io.modelcontextprotocol.client.McpAsyncClient&nbsp;mcpSession,
<a href="McpSessionManager.html" title="class in com.google.adk.tools.mcp">McpSessionManager</a>&nbsp;mcpSessionManager)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new McpAsyncTool with the default ObjectMapper.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(io.modelcontextprotocol.spec.McpSchema.Tool,io.modelcontextprotocol.client.McpAsyncClient,com.google.adk.tools.mcp.McpSessionManager,com.fasterxml.jackson.databind.ObjectMapper)" class="member-name-link">McpAsyncTool</a><wbr>(io.modelcontextprotocol.spec.McpSchema.Tool&nbsp;mcpTool,
io.modelcontextprotocol.client.McpAsyncClient&nbsp;mcpSession,
<a href="McpSessionManager.html" title="class in com.google.adk.tools.mcp">McpSessionManager</a>&nbsp;mcpSessionManager,
com.fasterxml.jackson.databind.ObjectMapper&nbsp;objectMapper)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a new McpAsyncTool</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runAsync(java.util.Map,com.google.adk.tools.ToolContext)" class="member-name-link">runAsync</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calls a tool.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-com.google.adk.tools.mcp.AbstractMcpTool">Methods inherited from class&nbsp;<a href="AbstractMcpTool.html#method-summary" title="class in com.google.adk.tools.mcp">AbstractMcpTool</a></h3>
<code><a href="AbstractMcpTool.html#annotations()" title="annotations()">annotations</a>, <a href="AbstractMcpTool.html#declaration()" title="declaration()">declaration</a>, <a href="AbstractMcpTool.html#getMcpSession()" title="getMcpSession()">getMcpSession</a>, <a href="AbstractMcpTool.html#meta()" title="meta()">meta</a>, <a href="AbstractMcpTool.html#wrapCallResult(com.fasterxml.jackson.databind.ObjectMapper,java.lang.String,io.modelcontextprotocol.spec.McpSchema.CallToolResult)" title="wrapCallResult(ObjectMapper, String, McpSchema.CallToolResult)">wrapCallResult</a></code>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>io.modelcontextprotocol.spec.McpSchema.ToolAnnotations</code></div>
<div class="col-second even-row-color"><code><a href="AbstractMcpTool.html#annotations()" class="member-name-link">annotations</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><wbr>&lt;com.google.genai.types.FunctionDeclaration&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="AbstractMcpTool.html#declaration()" class="member-name-link">declaration</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Gets the <code>FunctionDeclaration</code> representation of this tool.</div>
</div>
<div class="col-first even-row-color"><code>io.modelcontextprotocol.client.McpAsyncClient</code></div>
<div class="col-second even-row-color"><code><a href="AbstractMcpTool.html#getMcpSession()" class="member-name-link">getMcpSession</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="AbstractMcpTool.html#meta()" class="member-name-link">meta</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="AbstractMcpTool.html#wrapCallResult(com.fasterxml.jackson.databind.ObjectMapper,java.lang.String,io.modelcontextprotocol.spec.McpSchema.CallToolResult)" class="member-name-link">wrapCallResult</a><wbr>(com.fasterxml.jackson.databind.ObjectMapper&nbsp;objectMapper,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>&nbsp;mcpToolName,
io.modelcontextprotocol.spec.McpSchema.CallToolResult&nbsp;callResult)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-com.google.adk.tools.BaseTool">Methods inherited from class&nbsp;<a href="../BaseTool.html#method-summary" title="class in com.google.adk.tools">BaseTool</a></h3>
<code><a href="../BaseTool.html#customMetadata()" title="customMetadata()">customMetadata</a>, <a href="../BaseTool.html#description()" title="description()">description</a>, <a href="../BaseTool.html#fromConfig(com.google.adk.tools.BaseTool.ToolConfig,java.lang.String)" title="fromConfig(BaseTool.ToolConfig, String)">fromConfig</a>, <a href="../BaseTool.html#longRunning()" title="longRunning()">longRunning</a>, <a href="../BaseTool.html#name()" title="name()">name</a>, <a href="../BaseTool.html#processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)" title="processLlmRequest(LlmRequest.Builder, ToolContext)">processLlmRequest</a>, <a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.core.type.TypeReference)" title="runAsync(I, ToolContext, TypeReference)">runAsync</a>, <a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.core.type.TypeReference)" title="runAsync(I, ToolContext, ObjectMapper, TypeReference)">runAsync</a>, <a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,java.lang.Class)" title="runAsync(I, ToolContext, ObjectMapper, Class)">runAsync</a>, <a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,java.lang.Class)" title="runAsync(I, ToolContext, Class)">runAsync</a>, <a href="../BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext)" title="runAsync(T, ToolContext)">runAsync</a>, <a href="../BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper)" title="runAsync(T, ToolContext, ObjectMapper)">runAsync</a>, <a href="../BaseTool.html#setCustomMetadata(java.lang.String,java.lang.Object)" title="setCustomMetadata(String, Object)">setCustomMetadata</a></code>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>com.google.common.collect.ImmutableMap<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#customMetadata()" class="member-name-link">customMetadata</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Returns a read-only view of the tool metadata.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.html#description()" class="member-name-link">description</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static <a href="../BaseTool.html" title="class in com.google.adk.tools">BaseTool</a></code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#fromConfig(com.google.adk.tools.BaseTool.ToolConfig,java.lang.String)" class="member-name-link">fromConfig</a><wbr>(<a href="../BaseTool.ToolConfig.html" title="class in com.google.adk.tools">BaseTool.ToolConfig</a>&nbsp;config,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>&nbsp;configAbsPath)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a tool instance from a config.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.html#longRunning()" class="member-name-link">longRunning</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#name()" class="member-name-link">name</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>io.reactivex.rxjava3.core.Completable</code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.html#processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)" class="member-name-link">processLlmRequest</a><wbr>(<a href="../../models/LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a>&nbsp;llmRequestBuilder,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext)</code></div>
<div class="col-last odd-row-color">
<div class="block">Processes the outgoing <a href="../../models/LlmRequest.Builder.html" title="class in com.google.adk.models"><code>LlmRequest.Builder</code></a>.</div>
</div>
<div class="col-first even-row-color"><code>final &lt;I,<wbr>O&gt;&nbsp;io.reactivex.rxjava3.core.Single<wbr>&lt;O&gt;</code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.core.type.TypeReference)" class="member-name-link">runAsync</a><wbr>(I&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
com.fasterxml.jackson.core.type.TypeReference&lt;? extends O&gt;&nbsp;typeReference)</code></div>
<div class="col-last even-row-color">
<div class="block">Calls a tool with generic arguments, returning the results converted to a specified type
reference.</div>
</div>
<div class="col-first odd-row-color"><code>final &lt;I,<wbr>O&gt;&nbsp;io.reactivex.rxjava3.core.Single<wbr>&lt;O&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.core.type.TypeReference)" class="member-name-link">runAsync</a><wbr>(I&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
com.fasterxml.jackson.databind.ObjectMapper&nbsp;objectMapper,
com.fasterxml.jackson.core.type.TypeReference&lt;? extends O&gt;&nbsp;typeReference)</code></div>
<div class="col-last odd-row-color">
<div class="block">Calls a tool with generic arguments and a custom <code>ObjectMapper</code>, returning the results
converted to a specified type reference.</div>
</div>
<div class="col-first even-row-color"><code>final &lt;I,<wbr>O&gt;&nbsp;io.reactivex.rxjava3.core.Single<wbr>&lt;O&gt;</code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,java.lang.Class)" class="member-name-link">runAsync</a><wbr>(I&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
com.fasterxml.jackson.databind.ObjectMapper&nbsp;objectMapper,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class in java.lang" class="external-link">Class</a>&lt;? extends O&gt;&nbsp;oClass)</code></div>
<div class="col-last even-row-color">
<div class="block">Calls a tool with generic arguments and a custom <code>ObjectMapper</code>, returning the results
converted to a specified class.</div>
</div>
<div class="col-first odd-row-color"><code>final &lt;I,<wbr>O&gt;&nbsp;io.reactivex.rxjava3.core.Single<wbr>&lt;O&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,java.lang.Class)" class="member-name-link">runAsync</a><wbr>(I&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class in java.lang" class="external-link">Class</a>&lt;? extends O&gt;&nbsp;oClass)</code></div>
<div class="col-last odd-row-color">
<div class="block">Calls a tool with generic arguments, returning the results converted to a specified class.</div>
</div>
<div class="col-first even-row-color"><code>final &lt;T&gt;&nbsp;io.reactivex.rxjava3.core.Single<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext)" class="member-name-link">runAsync</a><wbr>(T&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext)</code></div>
<div class="col-last even-row-color">
<div class="block">Calls a tool with generic arguments and returns a map of results.</div>
</div>
<div class="col-first odd-row-color"><code>final &lt;T&gt;&nbsp;io.reactivex.rxjava3.core.Single<wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="../BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper)" class="member-name-link">runAsync</a><wbr>(T&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext,
com.fasterxml.jackson.databind.ObjectMapper&nbsp;objectMapper)</code></div>
<div class="col-last odd-row-color">
<div class="block">Calls a tool with generic arguments using a custom <code>ObjectMapper</code> and returns a map of
results.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><code><a href="../BaseTool.html#setCustomMetadata(java.lang.String,java.lang.Object)" class="member-name-link">setCustomMetadata</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets custom metadata to the tool associated with a key.</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary" title="class in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="clone()" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="equals(Object)" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="finalize()" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="getClass()" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="hashCode()" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="notify()" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="notifyAll()" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="toString()" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="wait()" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="wait(long)" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="wait(long, int)" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(io.modelcontextprotocol.spec.McpSchema.Tool,io.modelcontextprotocol.client.McpAsyncClient,com.google.adk.tools.mcp.McpSessionManager)">
<h3>McpAsyncTool</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">McpAsyncTool</span><wbr><span class="parameters">(io.modelcontextprotocol.spec.McpSchema.Tool&nbsp;mcpTool,
io.modelcontextprotocol.client.McpAsyncClient&nbsp;mcpSession,
<a href="McpSessionManager.html" title="class in com.google.adk.tools.mcp">McpSessionManager</a>&nbsp;mcpSessionManager)</span></div>
<div class="block">Creates a new McpAsyncTool with the default ObjectMapper.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>mcpTool</code> - The MCP tool to wrap.</dd>
<dd><code>mcpSession</code> - The MCP session to use to call the tool.</dd>
<dd><code>mcpSessionManager</code> - The MCP session manager to use to create new sessions.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class in java.lang" class="external-link">IllegalArgumentException</a></code> - If mcpTool or mcpSession are null.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(io.modelcontextprotocol.spec.McpSchema.Tool,io.modelcontextprotocol.client.McpAsyncClient,com.google.adk.tools.mcp.McpSessionManager,com.fasterxml.jackson.databind.ObjectMapper)">
<h3>McpAsyncTool</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">McpAsyncTool</span><wbr><span class="parameters">(io.modelcontextprotocol.spec.McpSchema.Tool&nbsp;mcpTool,
io.modelcontextprotocol.client.McpAsyncClient&nbsp;mcpSession,
<a href="McpSessionManager.html" title="class in com.google.adk.tools.mcp">McpSessionManager</a>&nbsp;mcpSessionManager,
com.fasterxml.jackson.databind.ObjectMapper&nbsp;objectMapper)</span></div>
<div class="block">Creates a new McpAsyncTool</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>mcpTool</code> - The MCP tool to wrap.</dd>
<dd><code>mcpSession</code> - The MCP session to use to call the tool.</dd>
<dd><code>mcpSessionManager</code> - The MCP session manager to use to create new sessions.</dd>
<dd><code>objectMapper</code> - The ObjectMapper to use to convert JSON schemas.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class in java.lang" class="external-link">IllegalArgumentException</a></code> - If mcpTool or mcpSession are null.</dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="runAsync(java.util.Map,com.google.adk.tools.ToolContext)">
<h3>runAsync</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">io.reactivex.rxjava3.core.Single&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&gt;</span>&nbsp;<span class="element-name">runAsync</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>&gt;&nbsp;args,
<a href="../ToolContext.html" title="class in com.google.adk.tools">ToolContext</a>&nbsp;toolContext)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from class:&nbsp;<code><a href="../BaseTool.html#runAsync(java.util.Map,com.google.adk.tools.ToolContext)">BaseTool</a></code></span></div>
<div class="block">Calls a tool.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../BaseTool.html#runAsync(java.util.Map,com.google.adk.tools.ToolContext)">runAsync</a></code>&nbsp;in class&nbsp;<code><a href="../BaseTool.html" title="class in com.google.adk.tools">BaseTool</a></code></dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
<footer>
<hr>
<p class="legal-copy"><small>Copyright &#169; 1980. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>