From 01aa7208628a37d0b0e971513a7348485c606350 Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Thu, 13 Feb 2025 20:44:34 +0100 Subject: [PATCH] clean the Readme Signed-off-by: Christian Tzolov --- README.md | 66 +-------------------------------------------------- mcp/README.md | 2 ++ 2 files changed, 3 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index d6fd25f..7bd7593 100644 --- a/README.md +++ b/README.md @@ -6,70 +6,7 @@ It enables Java applications to interact with AI models and tools through a stan ## 📚 Reference Documentation -For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](docs/docs/overview.mdx). - - - - - -## Mudules - -### MCP - -Java implementation of the Model Context Protocol specification. It includes: -- 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: - - 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 - - -### 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. - - -## Installation - -Add the following dependencies to your Maven project: - -```xml - - - io.modelcontextprotocol.sdk - mcp - - - - - io.modelcontextprotocol.sdk - mcp-spring-webflux - - - - - io.modelcontextprotocol.sdk - mcp-spring-webmvc - -``` - -## Examples - -Explore these MCP examples in the [spring-ai-examples/model-context-protocol](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol) repository: - -- [SQLite Simple](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/sqlite/simple) - Demonstrates LLM integration with a database -- [SQLite Chatbot](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/sqlite/chatbot) - Interactive chatbot with SQLite database interaction -- [Filesystem](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/filesystem) - Enables LLM interaction with local filesystem folders and files -- [Brave](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/brave) - Enables natural language interactions with Brave Search, allowing you to perform internet searches. -- [Theme Park API Example](https://github.com/habuma/spring-ai-examples/tree/main/spring-ai-mcp) - Shows how to create an MCP server and client with Spring AI, exposing Theme Park API tools -- [Http SSE Client + WebMvc SSE Server](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/mcp-webmvc-server) - Showcases how to create and use MCP WebMvc servers and HttpClient clients with different capabilities. -- [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 +For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](https://modelcontextprotocol.io/sdk/java/mcp-overview). ## Development @@ -86,7 +23,6 @@ mvn clean install mvn test ``` - ## Contributing Contributions are welcome! Please: diff --git a/mcp/README.md b/mcp/README.md index 0e2257d..7a9ff85 100644 --- a/mcp/README.md +++ b/mcp/README.md @@ -1,3 +1,5 @@ # Java MCP SDK Java SDK implementation of the Model Context Protocol, enabling seamless integration with language models and AI tools. +For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](https://modelcontextprotocol.io/sdk/java/mcp-overview). +