Skip to content

Commit db809ae

Browse files
authored
Merge pull request modelcontextprotocol#741 from tzolov/java_doc_refs_update
docs(java): Update Java SDK documentation with improved navigation
2 parents 3503bf3 + 06353be commit db809ae

File tree

3 files changed

+26
-23
lines changed

3 files changed

+26
-23
lines changed

docs/sdk/java/mcp-client.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
title: MCP Client
2+
title: Java MCP Client
33
description: Learn how to use the Model Context Protocol (MCP) client to interact with MCP servers
44
---
55

6+
Go to the [Java MCP Server](/sdk/java/mcp-server) to learn how to build MCP servers or the [Java MCP Overview](/sdk/java/mcp-overview) to understand the overall architecture.
7+
68
# Model Context Protocol Client
79

810
The MCP Client is a key component in the Model Context Protocol (MCP) architecture, responsible for establishing and managing connections with MCP servers. It implements the client-side of the protocol, handling:
@@ -16,13 +18,17 @@ The MCP Client is a key component in the Model Context Protocol (MCP) architectu
1618
- Optional features like roots management and sampling support
1719

1820
<Tip>
19-
2021
The core `io.modelcontextprotocol.sdk:mcp` module provides STDIO and SSE client transport implementations without requiring external web frameworks.
2122

2223
Spring-specific transport implementations are available as an **optional** dependency `io.modelcontextprotocol.sdk:mcp-spring-webflux` for [Spring Framework](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) users.
2324

2425
</Tip>
2526

27+
<Tip>
28+
This [quickstart demo](/quickstart/client), based on Spring AI MCP, will show
29+
you how to build an AI client that connects to MCP servers.
30+
</Tip>
31+
2632
The client provides both synchronous and asynchronous APIs for flexibility in different application contexts.
2733

2834
<Tabs>

docs/sdk/java/mcp-overview.mdx

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
2-
title: Overview
2+
title: Java SDK Overview
33
description: Introduction to the Model Context Protocol (MCP) Java SDK
44
---
55

66
Java SDK for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture)
77
enables standardized integration between AI models and tools.
88

9-
<Note>
9+
## Content
1010

11-
### Breaking Changes in 0.8.x ⚠️
12-
13-
**Note:** Version 0.8.x introduces several breaking changes including a new session-based architecture.
14-
If you're upgrading from 0.7.0, please refer to the [Migration Guide](https://github.com/modelcontextprotocol/java-sdk/blob/main/migration-0.8.0.md) for detailed instructions.
15-
16-
</Note>
11+
- [Introduction](/sdk/java/mcp-overview#features) - Overview of the Model Context Protocol (MCP) Java SDK and its features.
12+
- [Architecture](/sdk/java/mcp-overview#architecture) - The Java MCP SDK architecture overview.
13+
- [Java Dependencies](/sdk/java/mcp-overview#dependencies) - Java dependencies required to use the MCP SDK.
14+
- [Java MCP Client](/sdk/java/mcp-client) - Learn how to use the MCP client to interact with MCP servers.
15+
- [Java MCP Server](/sdk/java/mcp-server) - Learn how to implement and configure an MCP server.
1716

1817
## Features
1918

@@ -55,12 +54,12 @@ The SDK follows a layered architecture with clear separation of concerns:
5554
- StdioTransport (stdin/stdout) in the core module
5655
- HTTP SSE transports in dedicated transport modules (Java HttpClient, Spring WebFlux, Spring WebMVC)
5756

58-
The MCP Client is a key component in the Model Context Protocol (MCP) architecture, responsible for establishing and managing connections with MCP servers.
57+
The [MCP Client](/sdk/java/mcp-client) is a key component in the Model Context Protocol (MCP) architecture, responsible for establishing and managing connections with MCP servers.
5958
It implements the client-side of the protocol.
6059

6160
![Java MCP Client Architecture](/images/java/java-mcp-client-architecture.jpg)
6261

63-
The MCP Server is a foundational component in the Model Context Protocol (MCP) architecture that provides tools, resources, and capabilities to clients.
62+
The [MCP Server](/sdk/java/mcp-server) is a foundational component in the Model Context Protocol (MCP) architecture that provides tools, resources, and capabilities to clients.
6463
It implements the server-side of the protocol.
6564

6665
![Java MCP Server Architecture](/images/java/java-mcp-server-architecture.jpg)
@@ -154,7 +153,7 @@ Add the BOM to your project:
154153
<dependency>
155154
<groupId>io.modelcontextprotocol.sdk</groupId>
156155
<artifactId>mcp-bom</artifactId>
157-
<version>0.9.0</version>
156+
<version>0.10.0</version>
158157
<type>pom</type>
159158
<scope>import</scope>
160159
</dependency>
@@ -168,7 +167,7 @@ Add the BOM to your project:
168167

169168
```groovy
170169
dependencies {
171-
implementation platform("io.modelcontextprotocol.sdk:mcp-bom:0.9.0")
170+
implementation platform("io.modelcontextprotocol.sdk:mcp-bom:0.10.0")
172171
//...
173172
}
174173
```

docs/sdk/java/mcp-server.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
---
2-
title: MCP Server
2+
title: Java MCP Server
33
description: Learn how to implement and configure a Model Context Protocol (MCP) server
44
---
55

6-
<Note>
7-
8-
### Breaking Changes in 0.8.x ⚠️
9-
10-
**Note:** Version 0.8.x introduces several breaking changes including a new session-based architecture.
11-
If you're upgrading from 0.7.0, please refer to the [Migration Guide](https://github.com/modelcontextprotocol/java-sdk/blob/main/migration-0.8.0.md) for detailed instructions.
12-
13-
</Note>
6+
Go to the [Java MCP Client](/sdk/java/mcp-client) to learn how to build MCP clients or [Java MCP Overview](/sdk/java/mcp-overview) for a general overview of the Model Context Protocol (MCP) in Java.
147

158
## Overview
169

@@ -32,6 +25,11 @@ Spring-specific transport implementations are available as an **optional** depen
3225

3326
</Tip>
3427

28+
<Tip>
29+
This [quickstart demo](/quickstart/server), based on Spring AI MCP, will show
30+
you how to build an MCP server.
31+
</Tip>
32+
3533
The server supports both synchronous and asynchronous APIs, allowing for flexible integration in different application contexts.
3634

3735
<Tabs>

0 commit comments

Comments
 (0)