Skip to content

feat(schema): add support for JSON Schema $defs and definitions #146

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

Merged
merged 4 commits into from
Apr 23, 2025
+132 −1
Merged

feat(schema): add support for JSON Schema $defs and definitions #146

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
10d1c1e
feat(schema): add support for JSON Schema $defs and definitions
arcaputo3 Apr 11, 2025
c7f96c2
refactor(tests): simplify JsonSchema test assertions
arcaputo3 Apr 16, 2025
ddf29b8
Merge branch 'main' into schema-updates
arcaputo3 Apr 17, 2025
a8eec6c
Merge branch 'main' into schema-updates
arcaputo3 Apr 21, 2025
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
4 changes: 3 additions & 1 deletion mcp/src/main/java/io/modelcontextprotocol/spec/McpSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,9 @@ public record JsonSchema( // @formatter:off
@JsonProperty("type") String type,
@JsonProperty("properties") Map<String, Object> properties,
@JsonProperty("required") List<String> required,
@JsonProperty("additionalProperties") Boolean additionalProperties) {
@JsonProperty("additionalProperties") Boolean additionalProperties,
@JsonProperty("$defs") Map<String, Object> defs,
@JsonProperty("definitions") Map<String, Object> definitions) {
} // @formatter:on

/**
Expand Down
145 changes: 145 additions & 0 deletions mcp/src/test/java/io/modelcontextprotocol/spec/McpSchemaTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.exc.InvalidTypeIdException;
import io.modelcontextprotocol.spec.McpSchema.TextResourceContents;
Expand Down Expand Up @@ -449,6 +450,106 @@ void testGetPromptResult() throws Exception {

// Tool Tests

@Test
void testJsonSchema() throws Exception {
String schemaJson = """
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"$ref": "#/$defs/Address"
}
},
"required": ["name"],
"$defs": {
"Address": {
"type": "object",
"properties": {
"street": {"type": "string"},
"city": {"type": "string"}
},
"required": ["street", "city"]
}
}
}
""";

McpSchema.JsonSchema schema = mapper.readValue(schemaJson, McpSchema.JsonSchema.class);

assertThat(schema.type()).isEqualTo("object");
assertThat(schema.properties()).containsKeys("name", "address");
assertThat(schema.required()).containsExactly("name");
assertThat(schema.defs()).isNotNull();
assertThat(schema.defs()).containsKey("Address");

String value = mapper.writeValueAsString(schema);

// Convert to map for easier assertions
Map<String, Object> jsonMap = mapper.readValue(value, new TypeReference<HashMap<String, Object>>() {
});
Map<String, Object> defs = (Map<String, Object>) jsonMap.get("$defs");
Map<String, Object> address = (Map<String, Object>) defs.get("Address");

assertThat(address).containsEntry("type", "object");
assertThat(((Map<String, Object>) ((Map<String, Object>) address.get("properties")).get("street")).get("type"))
.isEqualTo("string");
assertThat(((Map<String, Object>) ((Map<String, Object>) address.get("properties")).get("city")).get("type"))
.isEqualTo("string");
}

@Test
void testJsonSchemaWithDefinitions() throws Exception {
String schemaJson = """
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
}
},
"required": ["name"],
"definitions": {
"Address": {
"type": "object",
"properties": {
"street": {"type": "string"},
"city": {"type": "string"}
},
"required": ["street", "city"]
}
}
}
""";

McpSchema.JsonSchema schema = mapper.readValue(schemaJson, McpSchema.JsonSchema.class);

assertThat(schema.type()).isEqualTo("object");
assertThat(schema.properties()).containsKeys("name", "address");
assertThat(schema.required()).containsExactly("name");
assertThat(schema.definitions()).isNotNull();
assertThat(schema.definitions()).containsKey("Address");

String value = mapper.writeValueAsString(schema);

// Convert to map for easier assertions
Map<String, Object> jsonMap = mapper.readValue(value, new TypeReference<HashMap<String, Object>>() {
});
Map<String, Object> definitions = (Map<String, Object>) jsonMap.get("definitions");
Map<String, Object> address = (Map<String, Object>) definitions.get("Address");

assertThat(address).containsEntry("type", "object");
assertThat(((Map<String, Object>) ((Map<String, Object>) address.get("properties")).get("street")).get("type"))
.isEqualTo("string");
assertThat(((Map<String, Object>) ((Map<String, Object>) address.get("properties")).get("city")).get("type"))
.isEqualTo("string");
}

@Test
void testTool() throws Exception {
String schemaJson = """
Expand Down Expand Up @@ -477,6 +578,50 @@ void testTool() throws Exception {
{"name":"test-tool","description":"A test tool","inputSchema":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"number"}},"required":["name"]}}"""));
}

@Test
void testToolWithComplexSchema() throws Exception {
String complexSchemaJson = """
{
"type": "object",
"$defs": {
"Address": {
"type": "object",
"properties": {
"street": {"type": "string"},
"city": {"type": "string"}
},
"required": ["street", "city"]
}
},
"properties": {
"name": {"type": "string"},
"shippingAddress": {"$ref": "#/$defs/Address"}
},
"required": ["name", "shippingAddress"]
}
""";

McpSchema.Tool tool = new McpSchema.Tool("addressTool", "Handles addresses", complexSchemaJson);

// Verify the schema was properly parsed and stored with $defs
assertThat(tool.inputSchema().defs()).isNotNull();
assertThat(tool.inputSchema().defs()).containsKey("Address");

String value = mapper.writeValueAsString(tool);

// Convert to map for easier assertions
Map<String, Object> jsonMap = mapper.readValue(value, new TypeReference<HashMap<String, Object>>() {
});
Map<String, Object> inputSchema = (Map<String, Object>) jsonMap.get("inputSchema");
Map<String, Object> defs = (Map<String, Object>) inputSchema.get("$defs");
Map<String, Object> address = (Map<String, Object>) defs.get("Address");
Map<String, Object> properties = (Map<String, Object>) inputSchema.get("properties");
Map<String, Object> shippingAddress = (Map<String, Object>) properties.get("shippingAddress");

assertThat(address).containsEntry("type", "object");
assertThat(shippingAddress).containsEntry("$ref", "#/$defs/Address");
}

@Test
void testCallToolRequest() throws Exception {
Map<String, Object> arguments = new HashMap<>();
Expand Down