modelcontextprotocol/java-sdk
Watch
1
0
Fork
You've already forked java-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Convert asciidoc/antor docs to mintlify

Browse source
This commit is contained in:
Mark Pollack 2025-01-28 08:49:41 -05:00 • committed by Christian Tzolov
commit 7e73152ada
1 changed files with 1390 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

55
mintlify-docs/docs/overview.mdx Normal file
View file

@ -0,0 +1,55 @@
---
title: Overview
description: Introduction to the Model Context Protocol (MCP) Java SDK
---
# Java & Spring MCP
Java SDK and Spring Framework integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture), enabling standardized interaction with AI models and tools through both synchronous and asynchronous communication.
![Spring AI MCP Client Architecture](/images/spring-ai-mcp-client-architecture.jpg)
![Spring AI MCP Server Architecture](/images/spring-ai-mcp-server-architecture.jpg)
## Core Components
### [MCP Java SDK](/docs/mcp)
Core implementation of the Model Context Protocol specification, providing:
- Synchronous and asynchronous [Client](/docs/mcp#mcp-client) and [Server](/docs/mcp#mcp-server) implementations
- Tool discovery and execution
- Resource management with URI templates
- Prompt handling and management
- Structured logging
- Request and Notification handling
### MCP Transports
#### Core Transports
- Stdio-based (`StdioClientTransport`, `StdioServerTransport`) for process-based communication
- Java HttpClient-based SSE client (`HttpClientSseClientTransport`) for HTTP SSE Client-side streaming
- Servlet-based SSE server (`HttpServletSseServerTransport`) for HTTP SSE Server streaming using traditional Servlet API
#### Optional SSE Transports
- [WebFlux SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-transport/mcp-webflux-sse-transport) - Reactive HTTP streaming with Spring WebFlux (Client & Server)
- [WebMvc SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-transport/mcp-webmvc-sse-transport) - Spring MVC based SSE transport (Server only).
You can use the core `HttpClientSseClientTransport` transport as a SSE client.
## Getting Started
<Tabs>
<Tab title="Maven">
```xml
<!-- Core MCP -->
<dependency>
<groupId>org.modelcontextprotocol.sdk</groupId>
<artifactId>mcp</artifactId>
</dependency>
<!-- Optional: WebFlux SSE transport -->
<dependency>
<groupId>org.modelcontextprotocol.sdk</groupId>
<artifactId>mcp-webflux-sse-transport</artifactId>
</dependency>
```
</Tab>
</Tabs>