Introduce McpJsonMapper interface to decouple from Jackson #543
Conversation
| this.jsonMapper = new JacksonMcpJsonMapper(objectMapper); | ||
| return this; |
There was a problem hiding this comment.
| this.jsonMapper = new JacksonMcpJsonMapper(objectMapper); | |
| return this; | |
| return jsonMapper(new JacksonMcpJsonMapper(objectMapper)); |
|
Do you want to use Vert.x's json? |
We want to use Micronaut Serialization. But basically, the idea is to allow users to use whatever JSON Serialization they want. |
This pull request creates two modules, `mcp-json` and `mcp-json-jackson`. It removes the `com.fasterxml.jackson.core:jackson-databind` and `com.networknt:json-schema-validator` dependencies from the `mcp` module. The `mcp` module now only depends on `com.fasterxml.jackson.core:jackson-annotations`. To use Jackson, you have to add `mcp-jackson` to your dependencies in addition to `mcp`. I added the dependency `mcp-jackson` to both `mcp-spring-mvc` and `mcp-spring-webflux` to avoid a breaking change in those modules. It provides two [SPI](https://docs.oracle.com/javase/tutorial/sound/SPI-intro.html) `JsonSchemaValidatorSupplier` and `JacksonJsonSchemaValidatorSupplier` to allow easy replacement for consumers who don't want to use Jackson. This pull request also ensures no `McpJsonMapper` is instantiated if one is provided via a builder method. Only if the builders don't receive a `McpJsonMapper` mapper, one is instantiated in the `build` method of the builder. The logic behind this is to allow frameworks to provide a `McpJsonMapper` mapper singleton implementation and feed it to the builders without paying the price of instantiating `McpJsonMappers`, which will not be used. The goal is to be able to use the `ObjectMapper` singleton of an application also for the MCP code. ## Breaking changes - This pull request also removes the deprecated `Tool` constructors, and it updates every test to use the builder API to instantiate tools. - Several constructors taking an ObjectMapper or constructor which forced the instantiation of a generic `McpJsonMapper` have been removed.
|
I did not review everything in detail, but from a high level perspective, this PR looks great, thanks for contributing it @graemerocher @sdelamo. The main open question for me is related to Jackson 3 which is about to be released. If we want to support Jackson 2 and Jackson 3 (which continues to use the same If we just plan to upgrade from Jackson 2 to Jackson 3, current naming is fine. |
|
probably including the major version makes sense for Jackson. |
Motivation and Context
The current MCP SDK is coupled to Jackson which prevents the use of other JSON serialization libraries and techniques.
This PR is an initial go and abstracting away Jackson usage in order to generate discussion. Left in draft to gather feedback.
This pull request creates two modules,
mcp-jsonandmcp-json-jackson. It removes thecom.fasterxml.jackson.core:jackson-databindandcom.networknt:json-schema-validatordependencies from themcpmodule. Themcpmodule now only depends oncom.fasterxml.jackson.core:jackson-annotations.To use Jackson, you have to add
mcp-jacksonto your dependencies in addition tomcp. I added the dependencymcp-jacksonto bothmcp-spring-mvcandmcp-spring-webfluxto avoid a breaking change in those modules.It provides two SPI
JsonSchemaValidatorSupplierandJsonSchemaValidatorSupplierto allow easy replacement for consumers who don't want to use Jackson.This pull request also ensures no
McpJsonMapperis instantiated if one is provided via a builder method. Only if the builders don't receive aMcpJsonMappermapper, one is instantiated in thebuildmethod of the builder.The logic behind this is to allow frameworks to provide a
McpJsonMappermapper singleton implementation and feed it to the builders without paying the price of instantiatingMcpJsonMappers, which will not be used. The goal is to be able to use theObjectMappersingleton of an application also for the MCP code.How Has This Been Tested?
Yes tests included.
Breaking Changes
Toolconstructors, and it updates every test to use the builder API to instantiate tools.McpJsonMapperhave been removed.Types of changes
Checklist
Additional context