Skip to content

Preserve $schema in Typed Elicitation Requests #6793

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
TwistedRiCen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Preserve $schema in Typed Elicitation Requests #6793

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
2 changes: 0 additions & 2 deletions ...ain/java/org/springframework/ai/mcp/annotation/context/DefaultMcpAsyncRequestContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,6 @@ public Mono<ElicitResult> elicitationInternal(String message, Type type, Map<Str

private Map<String, Object> generateElicitSchema(Type type) {
Map<String, Object> schema = jsonHelper.fromJsonToMap(McpJsonSchemaGenerator.generateFromType(type));
// remove as elicitation schema does not support it
schema.remove("$schema");
return schema;
}

Expand Down
2 changes: 0 additions & 2 deletions ...main/java/org/springframework/ai/mcp/annotation/context/DefaultMcpSyncRequestContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,6 @@ private ElicitResult elicitationInternal(String message, Type type, Map<String,

private Map<String, Object> generateElicitSchema(Type type) {
Map<String, Object> schema = jsonHelper.fromJsonToMap(McpJsonSchemaGenerator.generateFromType(type));
// remove $schema as elicitation schema does not support it
schema.remove("$schema");
return schema;
}

Expand Down
25 changes: 25 additions & 0 deletions ...ava/org/springframework/ai/mcp/annotation/context/DefaultMcpAsyncRequestContextTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,31 @@ public void testElicitationWithMessageAndMeta() {
assertThat(capturedRequest.requestedSchema()).isNotNull();
}

@Test
public void testElicitationPreservesSchemaMetadata() {
ClientCapabilities capabilities = mock(ClientCapabilities.class);
ClientCapabilities.Elicitation elicitation = mock(ClientCapabilities.Elicitation.class);
when(capabilities.elicitation()).thenReturn(elicitation);
when(this.exchange.getClientCapabilities()).thenReturn(capabilities);

record Person(String name) {
}

ElicitResult expectedResult = mock(ElicitResult.class);
when(expectedResult.action()).thenReturn(ElicitResult.Action.ACCEPT);
when(expectedResult.content()).thenReturn(Map.of("name", "John"));
when(this.exchange.createElicitation(any(ElicitRequest.class))).thenReturn(Mono.just(expectedResult));

StepVerifier.create(this.context.elicit(Person.class)).expectNextCount(1).verifyComplete();

ArgumentCaptor<ElicitFormRequest> captor = ArgumentCaptor.forClass(ElicitFormRequest.class);
verify(this.exchange).createElicitation(captor.capture());

Map<String, Object> requestedSchema = captor.getValue().requestedSchema();
assertThat(requestedSchema).containsKeys("$schema", "type", "properties", "required");
assertThat(((Map<?, ?>) requestedSchema.get("properties")).containsKey("name")).isTrue();
}

@Test
public void testElicitationWithMetadata() {
ClientCapabilities capabilities = mock(ClientCapabilities.class);
Expand Down
25 changes: 25 additions & 0 deletions ...java/org/springframework/ai/mcp/annotation/context/DefaultMcpSyncRequestContextTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,31 @@ public void testElicitationWithTypeAndMessage() {
assertThat(capturedRequest.requestedSchema()).isNotNull();
}

@Test
public void testElicitationPreservesSchemaMetadata() {
ClientCapabilities capabilities = mock(ClientCapabilities.class);
ClientCapabilities.Elicitation elicitation = mock(ClientCapabilities.Elicitation.class);
when(capabilities.elicitation()).thenReturn(elicitation);
when(this.exchange.getClientCapabilities()).thenReturn(capabilities);

record Person(String name) {
}

ElicitResult expectedResult = mock(ElicitResult.class);
when(expectedResult.action()).thenReturn(ElicitResult.Action.ACCEPT);
when(expectedResult.content()).thenReturn(Map.of("name", "John"));
when(this.exchange.createElicitation(any(ElicitRequest.class))).thenReturn(expectedResult);

this.context.elicit(Person.class);

ArgumentCaptor<ElicitFormRequest> captor = ArgumentCaptor.forClass(ElicitFormRequest.class);
verify(this.exchange).createElicitation(captor.capture());

Map<String, Object> requestedSchema = captor.getValue().requestedSchema();
assertThat(requestedSchema).containsKeys("$schema", "type", "properties", "required");
assertThat(((Map<?, ?>) requestedSchema.get("properties")).containsKey("name")).isTrue();
}

@Test
public void testElicitationWithTypeMessageAndMeta() {
ClientCapabilities capabilities = mock(ClientCapabilities.class);
Expand Down