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

Class McpClient

java.lang.Object

org.apache.juneau.rest.client.mcp.AbstractMcpClient

org.apache.juneau.rest.client.mcp.v20250618.McpClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class McpClient
extends AbstractMcpClient

Typed 2025-06-18 Model Context Protocol (MCP) client facade.

Extends AbstractMcpClient, adding one typed method per 2025-06-18 JSON-RPC method (see McpMethods). Every method builds the corresponding v1 request bean, wraps it in a JsonRpcRequest, delegates to the inherited AbstractMcpClient.send(JsonRpcRequest), and then either returns the result re-marshaled into its typed v1 result bean, or throws an McpException built from the response's error.

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpClient.Builder	Fluent builder for McpClient.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	McpClient(McpClient.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static McpClient.Builder	builder()	Creates a new builder.
CallToolResult	callTool(String name, Map<String,Object> arguments)	Sends "tools/call".
CompleteResult	complete(CompletionReference ref, CompletionArgument argument)	Sends "completion/complete".
GetPromptResult	getPrompt(String name, Map<String,Object> arguments)	Sends "prompts/get".
InitializeResult	initialize()	Sends "initialize".
ListPromptsResult	listPrompts()	Sends "prompts/list".
ListResourcesResult	listResources()	Sends "resources/list".
ListResourceTemplatesResult	listResourceTemplates()	Sends "resources/templates/list".
ListToolsResult	listTools()	Sends "tools/list".
void	ping()	Sends "ping" to verify server liveness.
ReadResourceResult	readResource(String uri)	Sends "resources/read".

Methods inherited from class org.apache.juneau.rest.client.mcp.AbstractMcpClient

close, openEventStream, openEventStream, openEventStream, send, send

Methods inherited from class java.lang.Object

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

Constructor Details

McpClient

protected McpClient(McpClient.Builder builder)

Constructor.

Parameters:

builder - The builder supplying this client's configuration. Must not be null.

Method Details

builder

public static McpClient.Builder builder()

Creates a new builder.

Returns:

A new builder. Never null.

initialize

public InitializeResult initialize()
                            throws IOException

Sends "initialize".

Returns:

The initialize result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

ping

public void ping()
          throws IOException

Sends "ping" to verify server liveness.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

listTools

public ListToolsResult listTools()
                          throws IOException

Sends "tools/list".

Returns:

The tools-list result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

callTool

public CallToolResult callTool(String name,
 Map<String,Object> arguments)
                        throws IOException

Sends "tools/call".

Parameters:

name - The tool name to invoke.

arguments - The tool arguments. Can be null.

Returns:

The call-tool result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

listPrompts

public ListPromptsResult listPrompts()
                              throws IOException

Sends "prompts/list".

Returns:

The prompts-list result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

getPrompt

public GetPromptResult getPrompt(String name,
 Map<String,Object> arguments)
                          throws IOException

Sends "prompts/get".

Parameters:

name - The prompt name to fetch.

arguments - The prompt argument values. Can be null.

Returns:

The get-prompt result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

listResources

public ListResourcesResult listResources()
                                  throws IOException

Sends "resources/list".

Returns:

The resources-list result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

readResource

public ReadResourceResult readResource(String uri)
                                throws IOException

Sends "resources/read".

Parameters:

uri - The resource URI to read.

Returns:

The read-resource result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

listResourceTemplates

public ListResourceTemplatesResult listResourceTemplates()
                                                  throws IOException

Sends "resources/templates/list".

Returns:

The resource-templates-list result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.

complete

public CompleteResult complete(CompletionReference ref,
 CompletionArgument argument)
                        throws IOException

Sends "completion/complete".

Parameters:

ref - The completion target (a declared prompt or resource template reference).

argument - The prompt argument or resource-template variable being completed, and its current partial value.

Returns:

The completion result. Never null on success unless the server returns a null result.

Throws:

IOException - If a transport-level or (de)serialization error occurs.

McpException - If the server returned a JSON-RPC error.