Skip to content

Preserve OpenAPI 3.1 type arrays in MCP input schemas #3428

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

Preserve OpenAPI 3.1 type arrays in MCP input schemas #3428

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
7 changes: 6 additions & 1 deletion ...openapi-starter-common-mcp/src/main/java/org/springdoc/ai/mcp/OpenApiSchemaConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,12 @@ private static void applySchemaContent(Schema<?> schema, ObjectNode node, Compon

// Type and nullable
String type = getSchemaType(schema);
if (Boolean.TRUE.equals(schema.getNullable())) {
Set<String> types = schema.getTypes();
if (types != null && types.size() > 1) {
ArrayNode typeArray = node.putArray("type");
types.forEach(typeArray::add);
}
else if (Boolean.TRUE.equals(schema.getNullable())) {
ArrayNode typeArray = node.putArray("type");
typeArray.add(type != null ? type : "object");
typeArray.add("null");
Expand Down
36 changes: 36 additions & 0 deletions ...api-starter-common-mcp/src/test/java/org/springdoc/ai/mcp/OpenApiSchemaConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

import tools.jackson.databind.JsonNode;
import tools.jackson.databind.ObjectMapper;
import io.swagger.v3.core.util.Json31;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.media.Content;
Expand Down Expand Up @@ -751,6 +752,41 @@ void testNullableHandling() throws Exception {
assertThat(nicknameNode.get("type").get(1).asText()).isEqualTo("null");
}

/**
* Test that OpenAPI 3.1 request body properties retain every declared type.
* @throws Exception if JSON parsing fails
*/
@Test
void testOpenApi31TypeArraysInRequestBody() throws Exception {
Operation operation = Json31.mapper().readValue("""
{
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": { "type": ["string", "null"] },
"label": { "type": ["integer", "string"] }
}
}
}
}
}
}
""", Operation.class);

String schemaJson = OpenApiSchemaConverter.buildInputSchema("/notes", operation, null);
JsonNode properties = objectMapper.readTree(schemaJson).at("/properties/body/properties");

assertThat(properties.at("/content/type").isArray()).isTrue();
assertThat(properties.at("/content/type")).extracting(JsonNode::asText)
.containsExactlyInAnyOrder("string", "null");
assertThat(properties.at("/label/type").isArray()).isTrue();
assertThat(properties.at("/label/type")).extracting(JsonNode::asText)
.containsExactlyInAnyOrder("integer", "string");
}

/**
* Test that anyOf schemas produce a JSON Schema anyOf array in input schema.
* @throws Exception if JSON parsing fails
Expand Down
Loading