Skip to content

chore: Make SyncSpec and AsyncSpec extensible #674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+40 −36
Draft

chore: Make SyncSpec and AsyncSpec extensible #674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 40 additions & 36 deletions mcp-core/src/main/java/io/modelcontextprotocol/client/McpClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public interface McpClient {
* @throws IllegalArgumentException if transport is null
*/
static SyncSpec sync(McpClientTransport transport) {
return new SyncSpec(transport);
return new McpClient.SyncSpec(transport);
}

/**
Expand Down Expand Up @@ -156,44 +156,46 @@ static AsyncSpec async(McpClientTransport transport) {
* <li>Change notification handlers for tools, resources, and prompts
* <li>Custom message sampling logic
* </ul>
*
* This class can be extended by subclass.
*/
class SyncSpec {

private final McpClientTransport transport;
protected final McpClientTransport transport;

private Duration requestTimeout = Duration.ofSeconds(20); // Default timeout
protected Duration requestTimeout = Duration.ofSeconds(20); // Default timeout

private Duration initializationTimeout = Duration.ofSeconds(20);
protected Duration initializationTimeout = Duration.ofSeconds(20);

private ClientCapabilities capabilities;
protected ClientCapabilities capabilities;

private Implementation clientInfo = new Implementation("Java SDK MCP Client", "0.15.0");
protected Implementation clientInfo = new Implementation("Java SDK MCP Client", "0.15.0");

private final Map<String, Root> roots = new HashMap<>();
protected final Map<String, Root> roots = new HashMap<>();

private final List<Consumer<List<McpSchema.Tool>>> toolsChangeConsumers = new ArrayList<>();
protected final List<Consumer<List<McpSchema.Tool>>> toolsChangeConsumers = new ArrayList<>();

private final List<Consumer<List<McpSchema.Resource>>> resourcesChangeConsumers = new ArrayList<>();
protected final List<Consumer<List<McpSchema.Resource>>> resourcesChangeConsumers = new ArrayList<>();

private final List<Consumer<List<McpSchema.ResourceContents>>> resourcesUpdateConsumers = new ArrayList<>();
protected final List<Consumer<List<McpSchema.ResourceContents>>> resourcesUpdateConsumers = new ArrayList<>();

private final List<Consumer<List<McpSchema.Prompt>>> promptsChangeConsumers = new ArrayList<>();
protected final List<Consumer<List<McpSchema.Prompt>>> promptsChangeConsumers = new ArrayList<>();

private final List<Consumer<McpSchema.LoggingMessageNotification>> loggingConsumers = new ArrayList<>();
protected final List<Consumer<McpSchema.LoggingMessageNotification>> loggingConsumers = new ArrayList<>();

private final List<Consumer<McpSchema.ProgressNotification>> progressConsumers = new ArrayList<>();
protected final List<Consumer<McpSchema.ProgressNotification>> progressConsumers = new ArrayList<>();

private Function<CreateMessageRequest, CreateMessageResult> samplingHandler;
protected Function<CreateMessageRequest, CreateMessageResult> samplingHandler;

private Function<ElicitRequest, ElicitResult> elicitationHandler;
protected Function<ElicitRequest, ElicitResult> elicitationHandler;

private Supplier<McpTransportContext> contextProvider = () -> McpTransportContext.EMPTY;
protected Supplier<McpTransportContext> contextProvider = () -> McpTransportContext.EMPTY;

private JsonSchemaValidator jsonSchemaValidator;
protected JsonSchemaValidator jsonSchemaValidator;

private boolean enableCallToolSchemaCaching = false; // Default to false
protected boolean enableCallToolSchemaCaching = false; // Default to false

private SyncSpec(McpClientTransport transport) {
public SyncSpec(McpClientTransport transport) {
Assert.notNull(transport, "Transport must not be null");
this.transport = transport;
}
Expand Down Expand Up @@ -496,42 +498,44 @@ public McpSyncClient build() {
* <li>Change notification handlers for tools, resources, and prompts
* <li>Custom message sampling logic
* </ul>
*
* This class can be extended by subclass.
*/
class AsyncSpec {

private final McpClientTransport transport;
protected final McpClientTransport transport;

private Duration requestTimeout = Duration.ofSeconds(20); // Default timeout
protected Duration requestTimeout = Duration.ofSeconds(20); // Default timeout

private Duration initializationTimeout = Duration.ofSeconds(20);
protected Duration initializationTimeout = Duration.ofSeconds(20);

private ClientCapabilities capabilities;
protected ClientCapabilities capabilities;

private Implementation clientInfo = new Implementation("Java SDK MCP Client", "0.15.0");
protected Implementation clientInfo = new Implementation("Java SDK MCP Client", "0.15.0");

private final Map<String, Root> roots = new HashMap<>();
protected final Map<String, Root> roots = new HashMap<>();

private final List<Function<List<McpSchema.Tool>, Mono<Void>>> toolsChangeConsumers = new ArrayList<>();
protected final List<Function<List<McpSchema.Tool>, Mono<Void>>> toolsChangeConsumers = new ArrayList<>();

private final List<Function<List<McpSchema.Resource>, Mono<Void>>> resourcesChangeConsumers = new ArrayList<>();
protected final List<Function<List<McpSchema.Resource>, Mono<Void>>> resourcesChangeConsumers = new ArrayList<>();

private final List<Function<List<McpSchema.ResourceContents>, Mono<Void>>> resourcesUpdateConsumers = new ArrayList<>();
protected final List<Function<List<McpSchema.ResourceContents>, Mono<Void>>> resourcesUpdateConsumers = new ArrayList<>();

private final List<Function<List<McpSchema.Prompt>, Mono<Void>>> promptsChangeConsumers = new ArrayList<>();
protected final List<Function<List<McpSchema.Prompt>, Mono<Void>>> promptsChangeConsumers = new ArrayList<>();

private final List<Function<McpSchema.LoggingMessageNotification, Mono<Void>>> loggingConsumers = new ArrayList<>();
protected final List<Function<McpSchema.LoggingMessageNotification, Mono<Void>>> loggingConsumers = new ArrayList<>();

private final List<Function<McpSchema.ProgressNotification, Mono<Void>>> progressConsumers = new ArrayList<>();
protected final List<Function<McpSchema.ProgressNotification, Mono<Void>>> progressConsumers = new ArrayList<>();

private Function<CreateMessageRequest, Mono<CreateMessageResult>> samplingHandler;
protected Function<CreateMessageRequest, Mono<CreateMessageResult>> samplingHandler;

private Function<ElicitRequest, Mono<ElicitResult>> elicitationHandler;
protected Function<ElicitRequest, Mono<ElicitResult>> elicitationHandler;

private JsonSchemaValidator jsonSchemaValidator;
protected JsonSchemaValidator jsonSchemaValidator;

private boolean enableCallToolSchemaCaching = false; // Default to false
protected boolean enableCallToolSchemaCaching = false; // Default to false

private AsyncSpec(McpClientTransport transport) {
public AsyncSpec(McpClientTransport transport) {
Assert.notNull(transport, "Transport must not be null");
this.transport = transport;
}
Expand Down
Loading