From c69cc18eb6912b8eb1c4b17b9ff60bc49b5997b3 Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Mon, 17 Feb 2025 12:53:24 +0100 Subject: [PATCH] docs: add Spring AI MCP documentation and improve README clarity - Add Spring AI MCP documentation section with links to client/server starters - Fix license link text Signed-off-by: Christian Tzolov --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7bd7593..2157b7d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ # MCP Java SDK [![Build Status](https://github.com/modelcontextprotocol/java-sdk/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/modelcontextprotocol/java-sdk/actions/workflows/continuous-integration.yml) -Set of projects that provide Java SDK integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture). -It enables Java applications to interact with AI models and tools through a standardized interface, supporting both synchronous and asynchronous communication patterns. +A set of projects that provide Java SDK integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture). +This SDK enables Java applications to interact with AI models and tools through a standardized interface, supporting both synchronous and asynchronous communication patterns. ## 📚 Reference Documentation -For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](https://modelcontextprotocol.io/sdk/java/mcp-overview). +#### MCP Java SDK documentation +For comprehensive guides and SDK API documentation, visit the [MCP Java SDK Reference Documentation](https://modelcontextprotocol.io/sdk/java/mcp-overview). +#### Spring AI MCP documentation +[Spring AI MCP](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-overview.html) extends the MCP Java SDK with Spring Boot integration, providing both [client](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) and [server](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-server-boot-starter-docs.html) starters. Bootstrap your AI applications with MCP support using [Spring Initializer](https://start.spring.io). ## Development -- Building from Source +### Building from Source ```bash mvn clean install ``` -- Running Tests +### Running Tests ```bash mvn test @@ -44,4 +47,4 @@ Contributions are welcome! Please: ## License -This project is licensed under the [MIT](LICENSE). +This project is licensed under the [MIT License](LICENSE).