Skip to content

Support generic output schemas in async MCP tool providers #6791

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

Open
wxggzz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support generic output schemas in async MCP tool providers #6791

Show file tree
Hide file tree
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
15 changes: 10 additions & 5 deletions ...c/main/java/org/springframework/ai/mcp/annotation/provider/tool/AsyncMcpToolProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.ai.mcp.annotation.provider.tool;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.util.Comparator;
import java.util.List;
import java.util.function.BiFunction;
Expand Down Expand Up @@ -127,12 +128,16 @@ public List<AsyncToolSpecification> getToolSpecifications() {
&& !ReactiveUtils.isReactiveReturnTypeOfCallToolResult(mcpToolMethod)) {

ReactiveUtils.getReactiveReturnTypeArgument(mcpToolMethod).ifPresent(typeArgument -> {
Class<?> methodReturnType = typeArgument instanceof Class<?> ? (Class<?>) typeArgument
: null;
if (!ClassUtils.isPrimitiveOrWrapper(methodReturnType)
&& !ClassUtils.isSimpleValueType(methodReturnType)) {
if (typeArgument instanceof Class<?> methodReturnType) {
if (!ClassUtils.isPrimitiveOrWrapper(methodReturnType)
&& !ClassUtils.isSimpleValueType(methodReturnType)) {
toolBuilder.outputSchema(this.getJsonMapper(),
McpJsonSchemaGenerator.generateFromClass(methodReturnType));
}
}
else if (typeArgument instanceof ParameterizedType) {
toolBuilder.outputSchema(this.getJsonMapper(),
McpJsonSchemaGenerator.generateFromClass((Class<?>) typeArgument));
McpJsonSchemaGenerator.generateFromType(typeArgument));
}
});
}
Expand Down
13 changes: 9 additions & 4 deletions ...va/org/springframework/ai/mcp/annotation/provider/tool/AsyncStatelessMcpToolProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.ai.mcp.annotation.provider.tool;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.util.Comparator;
import java.util.List;
import java.util.function.BiFunction;
Expand Down Expand Up @@ -132,10 +133,14 @@ public List<AsyncToolSpecification> getToolSpecifications() {
&& !ReactiveUtils.isReactiveReturnTypeOfCallToolResult(mcpToolMethod)) {

ReactiveUtils.getReactiveReturnTypeArgument(mcpToolMethod).ifPresent(typeArgument -> {
Class<?> methodReturnType = typeArgument instanceof Class<?> ? (Class<?>) typeArgument
: null;
if (!ClassUtils.isPrimitiveOrWrapper(methodReturnType)
&& !ClassUtils.isSimpleValueType(methodReturnType)) {
if (typeArgument instanceof Class<?> methodReturnType) {
if (!ClassUtils.isPrimitiveOrWrapper(methodReturnType)
&& !ClassUtils.isSimpleValueType(methodReturnType)) {
toolBuilder.outputSchema(this.getJsonMapper(),
McpJsonSchemaGenerator.generateFromClass(methodReturnType));
}
}
else if (typeArgument instanceof ParameterizedType) {
toolBuilder.outputSchema(this.getJsonMapper(),
McpJsonSchemaGenerator.generateFromType(typeArgument));
}
Expand Down
36 changes: 36 additions & 0 deletions ...t/java/org/springframework/ai/mcp/annotation/provider/tool/AsyncMcpToolProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,42 @@ public Mono<List<CustomResult>> listResponseTool(String input) {
[{"message":"Processed: test"}]"""));
}

@Test
void testToolWithStructuredListReturnType() {
record CustomResult(String message) {
}

class ListResponseTool {

@McpTool(name = "list-response", description = "Tool List response", generateOutputSchema = true)
public Mono<List<CustomResult>> listResponseTool(String input) {
return Mono.just(List.of(new CustomResult("Processed: " + input)));
}

}

AsyncMcpToolProvider provider = new AsyncMcpToolProvider(List.of(new ListResponseTool()));

List<AsyncToolSpecification> toolSpecs = provider.getToolSpecifications();

assertThat(toolSpecs).hasSize(1);
AsyncToolSpecification toolSpec = toolSpecs.get(0);
assertThat(toolSpec.tool().outputSchema()).containsEntry("type", "array").containsKey("items");
assertThat(toolSpec.tool().outputSchema().toString()).contains("message");

Mono<CallToolResult> result = toolSpec.callHandler()
.apply(mock(McpAsyncServerExchange.class),
CallToolRequest.builder("list-response").arguments(Map.of("input", "test")).build());

StepVerifier.create(result).assertNext(callToolResult -> {
assertThat(callToolResult.isError()).isFalse();
assertThat(callToolResult.structuredContent()).isInstanceOf(List.class);
assertThat((List<?>) callToolResult.structuredContent()).singleElement()
.isInstanceOfSatisfying(Map.class,
item -> assertThat(item).containsEntry("message", "Processed: test"));
}).verifyComplete();
}

@Test
void testToolWithFluxReturnType() {

Expand Down
36 changes: 36 additions & 0 deletions ...g/springframework/ai/mcp/annotation/provider/tool/AsyncStatelessMcpToolProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -952,6 +952,42 @@ public Mono<CustomResult> noOutputSchemaTool(String input) {
assertThat(toolSpec.tool().outputSchema()).isNull();
}

@Test
void testToolWithStructuredListReturnType() {
record CustomResult(String message) {
}

class ListResponseTool {

@McpTool(name = "list-response", description = "Tool List response", generateOutputSchema = true)
public Mono<List<CustomResult>> listResponseTool(String input) {
return Mono.just(List.of(new CustomResult("Processed: " + input)));
}

}

AsyncStatelessMcpToolProvider provider = new AsyncStatelessMcpToolProvider(List.of(new ListResponseTool()));

List<AsyncToolSpecification> toolSpecs = provider.getToolSpecifications();

assertThat(toolSpecs).hasSize(1);
AsyncToolSpecification toolSpec = toolSpecs.get(0);
assertThat(toolSpec.tool().outputSchema()).containsEntry("type", "array").containsKey("items");
assertThat(toolSpec.tool().outputSchema().toString()).contains("message");

Mono<CallToolResult> result = toolSpec.callHandler()
.apply(mock(McpTransportContext.class),
CallToolRequest.builder("list-response").arguments(Map.of("input", "test")).build());

StepVerifier.create(result).assertNext(callToolResult -> {
assertThat(callToolResult.isError()).isFalse();
assertThat(callToolResult.structuredContent()).isInstanceOf(List.class);
assertThat((List<?>) callToolResult.structuredContent()).singleElement()
.isInstanceOfSatisfying(Map.class,
item -> assertThat(item).containsEntry("message", "Processed: test"));
}).verifyComplete();
}

@Test
void testGetToolSpecificationsWithOutputSchemaGeneration() {
// Helper class for complex return type
Expand Down