Skip to content

Commit 8cd3cfd

Browse files
committed
Improve docs
1 parent 585f30c commit 8cd3cfd

27 files changed

+18
-1721
lines changed

README.md

Lines changed: 8 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
# Java & Spring MCP
1+
# MCP Java SDK
22
[![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)
33

4-
Set of projects that provide Java SDK and Spring Framework integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture).
4+
Set of projects that provide Java SDK integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture).
55
It enables Java applications to interact with AI models and tools through a standardized interface, supporting both synchronous and asynchronous communication patterns.
66

77
## 📚 Reference Documentation
8-
For comprehensive guides and API documentation, visit the [Spring AI MCP Reference Documentation](https://docs.spring.io/spring-ai-mcp/reference/overview.html).
98

10-
<img src="mcp-docs/src/main/antora/modules/ROOT/images/spring-ai-mcp-clinet-architecture.jpg" width="600">
9+
For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](docs/docs/overview.mdx).
1110

12-
<img src="mcp-docs/src/main/antora/modules/ROOT/images/spring-ai-mcp-server-architecture.jpg" width="600">
11+
<img src="docs/images/java-mcp-client-architecture" width="600">
12+
13+
<img src="docs/images/java-mcp-server-architecture.jpg" width="600">
1314

1415
## Projects
1516

16-
### [MCP Java SDK](https://docs.spring.io/spring-ai-mcp/reference/mcp.html)
17+
### MCP
1718

1819
Java implementation of the Model Context Protocol specification. It includes:
1920
- 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
2021
- Standard MCP operations support (tool discovery, resource management, prompt handling, structured logging). Support for request and notification handling.
2122
- [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.
2223

23-
### MCP Transports
24+
### MCP Spring
2425

2526
#### Core Transports
2627
- Stdio-based (`StdioClientTransport`, `StdioServerTransport`) for process-based communication
@@ -32,13 +33,6 @@ Java implementation of the Model Context Protocol specification. It includes:
3233
- [WebMvc SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webmvc) - Spring MVC based HTTP SSE transport (Server only).
3334
You can use the core `HttpClientSseClientTransport` transport as a SSE client.
3435

35-
### [Spring AI MCP](https://docs.spring.io/spring-ai-mcp/reference/spring-mcp.html)
36-
37-
The Spring integration module provides Spring-specific functionality:
38-
- Integration with Spring AI's function calling system
39-
- Spring-friendly abstractions for MCP clients
40-
- Auto-configurations (WIP)
41-
4236

4337
## Installation
4438

@@ -64,24 +58,6 @@ Add the following dependencies to your Maven project:
6458
</dependency>
6559
```
6660

67-
This is a milestone release, not available on Maven Central.
68-
Add this repository to your POM:
69-
70-
```xml
71-
<repositories>
72-
<repository>
73-
<id>spring-milestones</id>
74-
<name>Spring Milestones</name>
75-
<url>https://repo.spring.io/milestone</url>
76-
<snapshots>
77-
<enabled>false</enabled>
78-
</snapshots>
79-
</repository>
80-
</repositories>
81-
```
82-
83-
Reffer to the [Dependency Management](https://docs.spring.io/spring-ai-mcp/reference/dependency-management.html) page for more information.
84-
8561
## Example Demos
8662

8763
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:

docs/docs/dependency-management.mdx

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -64,41 +64,3 @@ The following dependencies are available and managed by the BOM:
6464

6565
- `org.modelcontextprotocol.sdk:mcp-test` - Testing utilities and support for MCP-based applications.
6666

67-
### Milestone and Snapshot Repositories
68-
69-
To use the Milestone and Snapshot version, you need to add references to the Spring Milestone and/or Snapshot repositories in your build file.
70-
Add the following repository definitions to your Maven or Gradle build file:
71-
72-
<Tabs>
73-
<Tab title="Maven">
74-
```xml
75-
<repositories>
76-
<repository>
77-
<id>spring-milestones</id>
78-
<n>Spring Milestones</n>
79-
<url>https://repo.spring.io/milestone</url>
80-
<snapshots>
81-
<enabled>false</enabled>
82-
</snapshots>
83-
</repository>
84-
<repository>
85-
<id>spring-snapshots</id>
86-
<n>Spring Snapshots</n>
87-
<url>https://repo.spring.io/snapshot</url>
88-
<releases>
89-
<enabled>false</enabled>
90-
</releases>
91-
</repository>
92-
</repositories>
93-
```
94-
</Tab>
95-
96-
<Tab title="Gradle">
97-
```groovy
98-
repositories {
99-
maven { url 'https://repo.spring.io/milestone' }
100-
maven { url 'https://repo.spring.io/snapshot' }
101-
}
102-
```
103-
</Tab>
104-
</Tabs>

docs/docs/mcp-overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ description: Overview of the Model Context Protocol (MCP) architecture and key c
77

88
Java SDK implementation of the [Model Context Protocol](https://modelcontextprotocol.io/introduction), enabling seamless integration with language models and AI tools.
99

10-
![Spring AI MCP Client Architecture](/images/spring-ai-mcp-client-architecture.jpg)
11-
![Spring AI MCP Server Architecture](/images/spring-ai-mcp-server-architecture.jpg)
10+
![Spring AI MCP Client Architecture](/images/java-mcp-client-architecture.jpg)
11+
![Spring AI MCP Server Architecture](/images/java-mcp-server-architecture.jpg)
1212

1313
## Features
1414

@@ -43,7 +43,7 @@ The SDK follows a layered architecture with clear separation of concerns:
4343

4444
Following class diagram illustrates the layered architecture of the MCP SDK, showing the relationships between core interfaces (McpTransport, McpSession), their implementations, and the client/server components. It highlights how the transport layer connects to sessions, which in turn support both synchronous and asynchronous client/server implementations.
4545

46-
![MCP SDK Class Diagram](/images/spring-ai-mcp-uml-classdiagram.svg)
46+
![MCP SDK Class Diagram](/images/java-mcp-uml-classdiagram.svg)
4747

4848
Key Interactions:
4949

docs/docs/overview.mdx

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,12 @@ title: Overview
33
description: Introduction to the Model Context Protocol (MCP) Java SDK
44
---
55

6-
# Java & Spring MCP
6+
# MCP Java SDK
77

8-
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.
8+
Java SDK 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.
99

10-
![Spring AI MCP Client Architecture](/images/spring-ai-mcp-client-architecture.jpg)
11-
![Spring AI MCP Server Architecture](/images/spring-ai-mcp-server-architecture.jpg)
12-
13-
## Core Components
14-
15-
### [MCP Java SDK](/docs/mcp)
16-
Core implementation of the Model Context Protocol specification, providing:
17-
18-
- Synchronous and asynchronous [Client](/docs/mcp#mcp-client) and [Server](/docs/mcp#mcp-server) implementations
19-
- Tool discovery and execution
20-
- Resource management with URI templates
21-
- Prompt handling and management
22-
- Structured logging
23-
- Request and Notification handling
24-
25-
### MCP Transports
26-
27-
#### Core Transports
28-
- Stdio-based (`StdioClientTransport`, `StdioServerTransport`) for process-based communication
29-
- Java HttpClient-based SSE client (`HttpClientSseClientTransport`) for HTTP SSE Client-side streaming
30-
- Servlet-based SSE server (`HttpServletSseServerTransport`) for HTTP SSE Server streaming using traditional Servlet API
31-
32-
#### Optional SSE Transports
33-
- [WebFlux SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webflux) - Reactive HTTP streaming with Spring WebFlux (Client & Server)
34-
- [WebMvc SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webmvc) - Spring MVC based SSE transport (Server only).
35-
You can use the core `HttpClientSseClientTransport` transport as a SSE client.
10+
![Java MCP Client Architecture](/images/java-mcp-client-architecture.jpg)
11+
![Java MCP Server Architecture](/images/java-mcp-server-architecture.jpg)
3612

3713
## Getting Started
3814

661 KB
Loading
840 KB
Loading
Binary file not shown.
Binary file not shown.

docs/mint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"docs/mcp-overview",
3434
"docs/mcp-client",
3535
"docs/mcp-server",
36-
"docs/mcp-spring",
36+
"docs/mcp-transport",
3737
"docs/mcp-capabilities"
3838
]
3939
}

0 commit comments

Comments
 (0)