Skip to content

Commit d4a1bfa

Browse files
pantanurag555tzolov
pantanurag555
authored and
tzolov
committed
feat: Improve pagination support on client side (#306)
This change enhances the client API by providing both paginated access for fine-grained control and convenience methods for retrieving complete result sets automatically. - Implement "list all" methods that automatically handle pagination using expand/reduce operations - Replace null parameters with McpSchema.FIRST_PAGE constant for better readability - Add tests for both paginated and "list all" functionality - Update method javadocs to clarify pagination behavior - Maintain backward compatibility Signed-off-by: Christian Tzolov <[email protected]>
1 parent aff24fd commit d4a1bfa

File tree

10 files changed

+403
-94
lines changed

10 files changed

+403
-94
lines changed

‎mcp-spring/mcp-spring-webflux/src/main/java/io/modelcontextprotocol/client/transport/WebClientStreamableHttpTransport.java‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
package io.modelcontextprotocol.client.transport;
22

3-
import com.fasterxml.jackson.core.type.TypeReference;
4-
import com.fasterxml.jackson.databind.ObjectMapper;
5-
import io.modelcontextprotocol.spec.DefaultMcpTransportSession;
6-
import io.modelcontextprotocol.spec.DefaultMcpTransportStream;
7-
import io.modelcontextprotocol.spec.McpClientTransport;
8-
import io.modelcontextprotocol.spec.McpError;
9-
import io.modelcontextprotocol.spec.McpSchema;
10-
import io.modelcontextprotocol.spec.McpTransportSessionNotFoundException;
11-
import io.modelcontextprotocol.spec.McpTransportSession;
12-
import io.modelcontextprotocol.spec.McpTransportStream;
13-
import io.modelcontextprotocol.util.Assert;
3+
import java.io.IOException;
4+
import java.util.List;
5+
import java.util.Optional;
6+
import java.util.concurrent.atomic.AtomicReference;
7+
import java.util.function.Consumer;
8+
import java.util.function.Function;
9+
1410
import org.reactivestreams.Publisher;
1511
import org.slf4j.Logger;
1612
import org.slf4j.LoggerFactory;
@@ -21,20 +17,25 @@
2117
import org.springframework.web.reactive.function.client.ClientResponse;
2218
import org.springframework.web.reactive.function.client.WebClient;
2319
import org.springframework.web.reactive.function.client.WebClientResponseException;
20+
21+
import com.fasterxml.jackson.core.type.TypeReference;
22+
import com.fasterxml.jackson.databind.ObjectMapper;
23+
24+
import io.modelcontextprotocol.spec.DefaultMcpTransportSession;
25+
import io.modelcontextprotocol.spec.DefaultMcpTransportStream;
26+
import io.modelcontextprotocol.spec.McpClientTransport;
27+
import io.modelcontextprotocol.spec.McpError;
28+
import io.modelcontextprotocol.spec.McpSchema;
29+
import io.modelcontextprotocol.spec.McpTransportSession;
30+
import io.modelcontextprotocol.spec.McpTransportSessionNotFoundException;
31+
import io.modelcontextprotocol.spec.McpTransportStream;
32+
import io.modelcontextprotocol.util.Assert;
2433
import reactor.core.Disposable;
2534
import reactor.core.publisher.Flux;
2635
import reactor.core.publisher.Mono;
2736
import reactor.util.function.Tuple2;
2837
import reactor.util.function.Tuples;
2938

30-
import java.io.IOException;
31-
import java.util.List;
32-
import java.util.Optional;
33-
import java.util.concurrent.atomic.AtomicReference;
34-
import java.util.function.Consumer;
35-
import java.util.function.Function;
36-
import java.util.function.Supplier;
37-
3839
/**
3940
* An implementation of the Streamable HTTP protocol as defined by the
4041
* <code>2025-03-26</code> version of the MCP specification.

‎mcp-test/src/main/java/io/modelcontextprotocol/client/AbstractMcpAsyncClientResiliencyTests.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/*
2+
* Copyright 2024-2024 the original author or authors.
3+
*/
14
package io.modelcontextprotocol.client;
25

36
import eu.rekawek.toxiproxy.Proxy;

‎mcp-test/src/main/java/io/modelcontextprotocol/client/AbstractMcpAsyncClientTests.java‎

Lines changed: 75 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -149,13 +149,28 @@ void testConstructorWithInvalidArguments() {
149149

150150
@Test
151151
void testListToolsWithoutInitialization() {
152-
verifyCallSucceedsWithImplicitInitialization(client -> client.listTools(null), "listing tools");
152+
verifyCallSucceedsWithImplicitInitialization(client -> client.listTools(McpSchema.FIRST_PAGE), "listing tools");
153153
}
154154

155155
@Test
156156
void testListTools() {
157157
withClient(createMcpTransport(), mcpAsyncClient -> {
158-
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listTools(null)))
158+
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listTools(McpSchema.FIRST_PAGE)))
159+
.consumeNextWith(result -> {
160+
assertThat(result.tools()).isNotNull().isNotEmpty();
161+
162+
Tool firstTool = result.tools().get(0);
163+
assertThat(firstTool.name()).isNotNull();
164+
assertThat(firstTool.description()).isNotNull();
165+
})
166+
.verifyComplete();
167+
});
168+
}
169+
170+
@Test
171+
void testListAllTools() {
172+
withClient(createMcpTransport(), mcpAsyncClient -> {
173+
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listTools()))
159174
.consumeNextWith(result -> {
160175
assertThat(result.tools()).isNotNull().isNotEmpty();
161176

@@ -276,13 +291,33 @@ void testCallToolWithMessageAnnotations(String messageType) {
276291

277292
@Test
278293
void testListResourcesWithoutInitialization() {
279-
verifyCallSucceedsWithImplicitInitialization(client -> client.listResources(null), "listing resources");
294+
verifyCallSucceedsWithImplicitInitialization(client -> client.listResources(McpSchema.FIRST_PAGE),
295+
"listing resources");
280296
}
281297

282298
@Test
283299
void testListResources() {
284300
withClient(createMcpTransport(), mcpAsyncClient -> {
285-
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listResources(null)))
301+
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listResources(McpSchema.FIRST_PAGE)))
302+
.consumeNextWith(resources -> {
303+
assertThat(resources).isNotNull().satisfies(result -> {
304+
assertThat(result.resources()).isNotNull();
305+
306+
if (!result.resources().isEmpty()) {
307+
Resource firstResource = result.resources().get(0);
308+
assertThat(firstResource.uri()).isNotNull();
309+
assertThat(firstResource.name()).isNotNull();
310+
}
311+
});
312+
})
313+
.verifyComplete();
314+
});
315+
}
316+
317+
@Test
318+
void testListAllResources() {
319+
withClient(createMcpTransport(), mcpAsyncClient -> {
320+
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listResources()))
286321
.consumeNextWith(resources -> {
287322
assertThat(resources).isNotNull().satisfies(result -> {
288323
assertThat(result.resources()).isNotNull();
@@ -307,13 +342,33 @@ void testMcpAsyncClientState() {
307342

308343
@Test
309344
void testListPromptsWithoutInitialization() {
310-
verifyCallSucceedsWithImplicitInitialization(client -> client.listPrompts(null), "listing " + "prompts");
345+
verifyCallSucceedsWithImplicitInitialization(client -> client.listPrompts(McpSchema.FIRST_PAGE),
346+
"listing " + "prompts");
311347
}
312348

313349
@Test
314350
void testListPrompts() {
315351
withClient(createMcpTransport(), mcpAsyncClient -> {
316-
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listPrompts(null)))
352+
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listPrompts(McpSchema.FIRST_PAGE)))
353+
.consumeNextWith(prompts -> {
354+
assertThat(prompts).isNotNull().satisfies(result -> {
355+
assertThat(result.prompts()).isNotNull();
356+
357+
if (!result.prompts().isEmpty()) {
358+
Prompt firstPrompt = result.prompts().get(0);
359+
assertThat(firstPrompt.name()).isNotNull();
360+
assertThat(firstPrompt.description()).isNotNull();
361+
}
362+
});
363+
})
364+
.verifyComplete();
365+
});
366+
}
367+
368+
@Test
369+
void testListAllPrompts() {
370+
withClient(createMcpTransport(), mcpAsyncClient -> {
371+
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listPrompts()))
317372
.consumeNextWith(prompts -> {
318373
assertThat(prompts).isNotNull().satisfies(result -> {
319374
assertThat(result.prompts()).isNotNull();
@@ -469,12 +524,25 @@ else if (content instanceof BlobResourceContents blobContent) {
469524

470525
@Test
471526
void testListResourceTemplatesWithoutInitialization() {
472-
verifyCallSucceedsWithImplicitInitialization(client -> client.listResourceTemplates(),
527+
verifyCallSucceedsWithImplicitInitialization(client -> client.listResourceTemplates(McpSchema.FIRST_PAGE),
473528
"listing resource templates");
474529
}
475530

476531
@Test
477532
void testListResourceTemplates() {
533+
withClient(createMcpTransport(), mcpAsyncClient -> {
534+
StepVerifier
535+
.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listResourceTemplates(McpSchema.FIRST_PAGE)))
536+
.consumeNextWith(result -> {
537+
assertThat(result).isNotNull();
538+
assertThat(result.resourceTemplates()).isNotNull();
539+
})
540+
.verifyComplete();
541+
});
542+
}
543+
544+
@Test
545+
void testListAllResourceTemplates() {
478546
withClient(createMcpTransport(), mcpAsyncClient -> {
479547
StepVerifier.create(mcpAsyncClient.initialize().then(mcpAsyncClient.listResourceTemplates()))
480548
.consumeNextWith(result -> {

‎mcp-test/src/main/java/io/modelcontextprotocol/client/AbstractMcpSyncClientTests.java‎

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,14 +151,30 @@ void testConstructorWithInvalidArguments() {
151151

152152
@Test
153153
void testListToolsWithoutInitialization() {
154-
verifyCallSucceedsWithImplicitInitialization(client -> client.listTools(null), "listing tools");
154+
verifyCallSucceedsWithImplicitInitialization(client -> client.listTools(McpSchema.FIRST_PAGE), "listing tools");
155155
}
156156

157157
@Test
158158
void testListTools() {
159159
withClient(createMcpTransport(), mcpSyncClient -> {
160160
mcpSyncClient.initialize();
161-
ListToolsResult tools = mcpSyncClient.listTools(null);
161+
ListToolsResult tools = mcpSyncClient.listTools(McpSchema.FIRST_PAGE);
162+
163+
assertThat(tools).isNotNull().satisfies(result -> {
164+
assertThat(result.tools()).isNotNull().isNotEmpty();
165+
166+
Tool firstTool = result.tools().get(0);
167+
assertThat(firstTool.name()).isNotNull();
168+
assertThat(firstTool.description()).isNotNull();
169+
});
170+
});
171+
}
172+
173+
@Test
174+
void testListAllTools() {
175+
withClient(createMcpTransport(), mcpSyncClient -> {
176+
mcpSyncClient.initialize();
177+
ListToolsResult tools = mcpSyncClient.listTools();
162178

163179
assertThat(tools).isNotNull().satisfies(result -> {
164180
assertThat(result.tools()).isNotNull().isNotEmpty();
@@ -308,14 +324,33 @@ void testRootsListChanged() {
308324

309325
@Test
310326
void testListResourcesWithoutInitialization() {
311-
verifyCallSucceedsWithImplicitInitialization(client -> client.listResources(null), "listing resources");
327+
verifyCallSucceedsWithImplicitInitialization(client -> client.listResources(McpSchema.FIRST_PAGE),
328+
"listing resources");
312329
}
313330

314331
@Test
315332
void testListResources() {
316333
withClient(createMcpTransport(), mcpSyncClient -> {
317334
mcpSyncClient.initialize();
318-
ListResourcesResult resources = mcpSyncClient.listResources(null);
335+
ListResourcesResult resources = mcpSyncClient.listResources(McpSchema.FIRST_PAGE);
336+
337+
assertThat(resources).isNotNull().satisfies(result -> {
338+
assertThat(result.resources()).isNotNull();
339+
340+
if (!result.resources().isEmpty()) {
341+
Resource firstResource = result.resources().get(0);
342+
assertThat(firstResource.uri()).isNotNull();
343+
assertThat(firstResource.name()).isNotNull();
344+
}
345+
});
346+
});
347+
}
348+
349+
@Test
350+
void testListAllResources() {
351+
withClient(createMcpTransport(), mcpSyncClient -> {
352+
mcpSyncClient.initialize();
353+
ListResourcesResult resources = mcpSyncClient.listResources();
319354

320355
assertThat(resources).isNotNull().satisfies(result -> {
321356
assertThat(result.resources()).isNotNull();
@@ -466,15 +501,26 @@ else if (content instanceof BlobResourceContents blobContent) {
466501

467502
@Test
468503
void testListResourceTemplatesWithoutInitialization() {
469-
verifyCallSucceedsWithImplicitInitialization(client -> client.listResourceTemplates(null),
504+
verifyCallSucceedsWithImplicitInitialization(client -> client.listResourceTemplates(McpSchema.FIRST_PAGE),
470505
"listing resource templates");
471506
}
472507

473508
@Test
474509
void testListResourceTemplates() {
475510
withClient(createMcpTransport(), mcpSyncClient -> {
476511
mcpSyncClient.initialize();
477-
ListResourceTemplatesResult result = mcpSyncClient.listResourceTemplates(null);
512+
ListResourceTemplatesResult result = mcpSyncClient.listResourceTemplates(McpSchema.FIRST_PAGE);
513+
514+
assertThat(result).isNotNull();
515+
assertThat(result.resourceTemplates()).isNotNull();
516+
});
517+
}
518+
519+
@Test
520+
void testListAllResourceTemplates() {
521+
withClient(createMcpTransport(), mcpSyncClient -> {
522+
mcpSyncClient.initialize();
523+
ListResourceTemplatesResult result = mcpSyncClient.listResourceTemplates();
478524

479525
assertThat(result).isNotNull();
480526
assertThat(result.resourceTemplates()).isNotNull();

0 commit comments

Comments
 (0)