Package org.apache.juneau.rest.client.mcp.v20260728

Class ElicitationRequests

java.lang.Object

org.apache.juneau.rest.client.mcp.v20260728.ElicitationRequests

public final class ElicitationRequests
extends Object

Static helper for reading server→client MCP 2026-07-28 SEP-2322 elicitation requests out of McpClient.callRaw(java.lang.String, org.apache.juneau.bean.mcp.v20260728.RequestParams<?>)'s raw Map<String,Object> result (MRTR, the Multi-Round-Trip Requests loop, client side).

Paired with ElicitationResponses, which encodes the client's answers back into the wire shape a resume call expects — the same ElicitationRequests/ElicitationResponses split the server side already uses (server ElicitationRequests builds the pause signal; server ElicitationResponses reads the resumed answers).

Works at the raw map/JSON level rather than exposing typed overloads per concrete request bean, because CallToolRequest/GetPromptRequest/ReadResourceRequest share no common "has-inputResponses-and-requestState" interface (each independently declares its own pair of fields; their actual common base, RequestParams<T>, carries only _meta). A caller resuming, say, a CallToolRequest calls ElicitationResponses.toInputResponses(Map) for the raw payload, then makes its own .setInputResponses(...).setRequestState(...) call on the concrete bean it already knows it holds.

Since:

10.0.0

Method Summary

Modifier and Type	Method	Description
static boolean	isInputRequired(Map<String,Object> raw)	Whether a McpClient.callRaw(java.lang.String, org.apache.juneau.bean.mcp.v20260728.RequestParams<?>) result represents a paused elicitation (or any other MRTR pause).
static Map<String,ElicitRequest>	requests(Map<String,Object> raw)	Decodes raw's inputRequests into typed ElicitRequests.
static String	requestState(Map<String,Object> raw)	Returns raw's echoed continuation token.

Methods inherited from class java.lang.Object

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

Method Details

isInputRequired

public static boolean isInputRequired(Map<String,Object> raw)

Whether a McpClient.callRaw(java.lang.String, org.apache.juneau.bean.mcp.v20260728.RequestParams<?>) result represents a paused elicitation (or any other MRTR pause).

Parameters:

raw - The raw result from McpClient.callRaw(java.lang.String, org.apache.juneau.bean.mcp.v20260728.RequestParams<?>). Must not be null.

Returns:

true if raw.get("resultType") is "input_required".

Throws:

IllegalArgumentException - If raw is null.

requests

public static Map<String,ElicitRequest> requests(Map<String,Object> raw)

Decodes raw's inputRequests into typed ElicitRequests.

Each raw value is generic JSON (a Map after wire deserialization, per InputRequiredResult's lossless-map contract), converted via the same Json.to(Json.of(value), type) technique McpMrtrResumeContext.continuationAs(Class) demonstrates server-side. A value that is present but null decodes to a null entry (see the return doc); this mirrors ElicitationResponses.all(McpMrtrResumeContext)'s null-passthrough on the server side.

Every entry is decoded as an ElicitRequest, unconditionally — per InputRequiredResult's Javadoc, inputRequests entries may in principle be arbitrary sub-request kinds (sampling/roots/elicitation), not only elicitation. A non-elicitation entry (one that shares no field names with ElicitRequest) simply decodes to an all-null-fields ElicitRequest, since the underlying Json.to conversion tolerates unknown/missing bean properties; it is the caller's responsibility to only call this for elicitation-flavored MRTR pauses.

Parameters:

raw - The raw result from McpClient.callRaw(java.lang.String, org.apache.juneau.bean.mcp.v20260728.RequestParams<?>). Must not be null.

Returns:

A keyed map of typed requests. Never null (empty if raw carried none). Values may be null when the corresponding raw entry is absent/null.

Throws:

IllegalArgumentException - If raw is null.

ClassCastException - If raw.get("inputRequests") is present but is not, at runtime, a Map — which can only happen against a malformed/non-conforming remote response, since a well-formed one always deserializes inputRequests to a Map per JSON semantics.

RuntimeException - If any entry's decoded shape cannot be converted to ElicitRequest.

requestState

public static String requestState(Map<String,Object> raw)

Returns raw's echoed continuation token.

Parameters:

raw - The raw result from McpClient.callRaw(java.lang.String, org.apache.juneau.bean.mcp.v20260728.RequestParams<?>). Must not be null.

Returns:

The token, or null if absent.

Throws:

IllegalArgumentException - If raw is null.

ClassCastException - If raw.get("requestState") is present but is not, at runtime, a String — only possible against a malformed/non-conforming remote response.