From cd624a7d5719db9648711c986be9bc9a149a34e4 Mon Sep 17 00:00:00 2001 From: Oleksandr Popov Date: Sun, 6 Apr 2025 10:29:29 +0200 Subject: [PATCH] fix: correct typos and improve documentation (#35) Signed-off-by: Christian Tzolov --- mcp/pom.xml | 2 +- .../io/modelcontextprotocol/client/McpAsyncClient.java | 10 +++++++++- .../client/transport/HttpClientSseClientTransport.java | 2 +- .../client/transport/StdioClientTransport.java | 2 +- .../io/modelcontextprotocol/spec/McpClientSession.java | 4 ++-- .../spec/McpClientSessionTests.java | 2 +- 6 files changed, 15 insertions(+), 7 deletions(-) diff --git a/mcp/pom.xml b/mcp/pom.xml index f6e93b3..edb1c8f 100644 --- a/mcp/pom.xml +++ b/mcp/pom.xml @@ -97,7 +97,7 @@ test - diff --git a/mcp/src/main/java/io/modelcontextprotocol/client/McpAsyncClient.java b/mcp/src/main/java/io/modelcontextprotocol/client/McpAsyncClient.java index 379b47e..ce49b0a 100644 --- a/mcp/src/main/java/io/modelcontextprotocol/client/McpAsyncClient.java +++ b/mcp/src/main/java/io/modelcontextprotocol/client/McpAsyncClient.java @@ -364,7 +364,7 @@ public class McpAsyncClient { } // -------------------------- - // Basic Utilites + // Basic Utilities // -------------------------- /** @@ -751,6 +751,14 @@ public class McpAsyncClient { // -------------------------- // Logging // -------------------------- + /** + * Create a notification handler for logging notifications from the server. This + * handler automatically distributes logging messages to all registered consumers. + * @param loggingConsumers List of consumers that will be notified when a logging + * message is received. Each consumer receives the logging message notification. + * @return A NotificationHandler that processes log notifications by distributing the + * message to all registered consumers + */ private NotificationHandler asyncLoggingNotificationHandler( List>> loggingConsumers) { diff --git a/mcp/src/main/java/io/modelcontextprotocol/client/transport/HttpClientSseClientTransport.java b/mcp/src/main/java/io/modelcontextprotocol/client/transport/HttpClientSseClientTransport.java index 0b48253..a5bdd43 100644 --- a/mcp/src/main/java/io/modelcontextprotocol/client/transport/HttpClientSseClientTransport.java +++ b/mcp/src/main/java/io/modelcontextprotocol/client/transport/HttpClientSseClientTransport.java @@ -376,7 +376,7 @@ public class HttpClientSseClientTransport implements McpClientTransport { } /** - * Unmarshals data to the specified type using the configured object mapper. + * Unmarshal data to the specified type using the configured object mapper. * @param data the data to unmarshal * @param typeRef the type reference for the target type * @param the target type diff --git a/mcp/src/main/java/io/modelcontextprotocol/client/transport/StdioClientTransport.java b/mcp/src/main/java/io/modelcontextprotocol/client/transport/StdioClientTransport.java index f9a9784..9d71cbb 100644 --- a/mcp/src/main/java/io/modelcontextprotocol/client/transport/StdioClientTransport.java +++ b/mcp/src/main/java/io/modelcontextprotocol/client/transport/StdioClientTransport.java @@ -292,7 +292,7 @@ public class StdioClientTransport implements McpClientTransport { */ private void startOutboundProcessing() { this.handleOutbound(messages -> messages - // this bit is important since writes come from user threads and we + // this bit is important since writes come from user threads, and we // want to ensure that the actual writing happens on a dedicated thread .publishOn(outboundScheduler) .handle((message, s) -> { diff --git a/mcp/src/main/java/io/modelcontextprotocol/spec/McpClientSession.java b/mcp/src/main/java/io/modelcontextprotocol/spec/McpClientSession.java index e29646e..719a780 100644 --- a/mcp/src/main/java/io/modelcontextprotocol/spec/McpClientSession.java +++ b/mcp/src/main/java/io/modelcontextprotocol/spec/McpClientSession.java @@ -107,7 +107,7 @@ public class McpClientSession implements McpSession { public McpClientSession(Duration requestTimeout, McpClientTransport transport, Map> requestHandlers, Map notificationHandlers) { - Assert.notNull(requestTimeout, "The requstTimeout can not be null"); + Assert.notNull(requestTimeout, "The requestTimeout can not be null"); Assert.notNull(transport, "The transport can not be null"); Assert.notNull(requestHandlers, "The requestHandlers can not be null"); Assert.notNull(notificationHandlers, "The notificationHandlers can not be null"); @@ -127,7 +127,7 @@ public class McpClientSession implements McpSession { logger.debug("Received Response: {}", response); var sink = pendingResponses.remove(response.id()); if (sink == null) { - logger.warn("Unexpected response for unkown id {}", response.id()); + logger.warn("Unexpected response for unknown id {}", response.id()); } else { sink.success(response); diff --git a/mcp/src/test/java/io/modelcontextprotocol/spec/McpClientSessionTests.java b/mcp/src/test/java/io/modelcontextprotocol/spec/McpClientSessionTests.java index 715d665..f72be43 100644 --- a/mcp/src/test/java/io/modelcontextprotocol/spec/McpClientSessionTests.java +++ b/mcp/src/test/java/io/modelcontextprotocol/spec/McpClientSessionTests.java @@ -61,7 +61,7 @@ class McpClientSessionTests { void testConstructorWithInvalidArguments() { assertThatThrownBy(() -> new McpClientSession(null, transport, Map.of(), Map.of())) .isInstanceOf(IllegalArgumentException.class) - .hasMessageContaining("requstTimeout can not be null"); + .hasMessageContaining("The requestTimeout can not be null"); assertThatThrownBy(() -> new McpClientSession(TIMEOUT, null, Map.of(), Map.of())) .isInstanceOf(IllegalArgumentException.class)