From 0dc93e134d8900f0a172d29c0184a884ee11dc28 Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Wed, 29 Jan 2025 15:11:23 +0100 Subject: [PATCH] Improve README.md --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d38005a..4a639af 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ It enables Java applications to interact with AI models and tools through a stan For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](docs/docs/overview.mdx). - + @@ -17,18 +17,20 @@ For comprehensive guides and API documentation, visit the [MCP Java SDK Referenc ### MCP Java implementation of the Model Context Protocol specification. It includes: -- Synchronous and asynchronous [MCP Client](https://docs.spring.io/spring-ai-mcp/reference/mcp.html#_mcp_client) and [MCP Server](https://docs.spring.io/spring-ai-mcp/reference/mcp.html#_mcp_server) implementations +- Synchronous and asynchronous [MCP Client](docs/docs/mcp-client.mdx) and [MCP Server](docs/docs/mcp-server.mdx) implementations - Standard MCP operations support (tool discovery, resource management, prompt handling, structured logging). Support for request and notification handling. - [Stdio](https://spec.modelcontextprotocol.io/specification/2024-11-05/basic/transports/#stdio) and [SSE](https://spec.modelcontextprotocol.io/specification/2024-11-05/basic/transports/#http-with-sse) transport implementations. -### MCP Spring - -#### Core Transports +##### Core Transports - Stdio-based (`StdioClientTransport`, `StdioServerTransport`) for process-based communication - Java HttpClient-based SSE client (`HttpClientSseClientTransport`) for HTTP streaming - Servlet-based SSE server (`HttpServletSseServerTransport`) for HTTP SSE Server streaming using traditional Servlet API -#### Optional SSE Transports + +### MCP Spring + +Optional SSE Transports implementations usin gthe Spring Webflux or WebMvc libraries. + - [WebFlux SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webflux) - Reactive HTTP streaming with Spring WebFlux (Client & Server) - [WebMvc SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webmvc) - Spring MVC based HTTP SSE transport (Server only). You can use the core `HttpClientSseClientTransport` transport as a SSE client. @@ -71,11 +73,6 @@ Explore these MCP examples in the [spring-ai-examples/model-context-protocol](ht - [WebFlux SSE Client + WebFlux SSE Server](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/mcp-webflux-server) - Showcases how to create and use MCP WebFlux servers and clients with different capabilities - [HttpClient SSE Client + Servlet SSE Server](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/mcp-servlet-server) - Showcases how to create and use MCP Servlet SSE Server and HttpClient SSE Client with different capabilities -## Documentation - -- [Java MCP SDK documentation](mcp/README.md) - - [Reference documentation](docs/ref-index.md) - ## Development