Skip to content

Commit 0dc93e1

Browse files
committed
Improve README.md
1 parent 8cd3cfd commit 0dc93e1

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It enables Java applications to interact with AI models and tools through a stan
88

99
For comprehensive guides and API documentation, visit the [MCP Java SDK Reference Documentation](docs/docs/overview.mdx).
1010

11-
<img src="docs/images/java-mcp-client-architecture" width="600">
11+
<img src="docs/images/java-mcp-client-architecture.jpg" width="600">
1212

1313
<img src="docs/images/java-mcp-server-architecture.jpg" width="600">
1414

@@ -17,18 +17,20 @@ For comprehensive guides and API documentation, visit the [MCP Java SDK Referenc
1717
### MCP
1818

1919
Java implementation of the Model Context Protocol specification. It includes:
20-
- 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
20+
- Synchronous and asynchronous [MCP Client](docs/docs/mcp-client.mdx) and [MCP Server](docs/docs/mcp-server.mdx) implementations
2121
- Standard MCP operations support (tool discovery, resource management, prompt handling, structured logging). Support for request and notification handling.
2222
- [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.
2323

24-
### MCP Spring
25-
26-
#### Core Transports
24+
##### Core Transports
2725
- Stdio-based (`StdioClientTransport`, `StdioServerTransport`) for process-based communication
2826
- Java HttpClient-based SSE client (`HttpClientSseClientTransport`) for HTTP streaming
2927
- Servlet-based SSE server (`HttpServletSseServerTransport`) for HTTP SSE Server streaming using traditional Servlet API
3028

31-
#### Optional SSE Transports
29+
30+
### MCP Spring
31+
32+
Optional SSE Transports implementations usin gthe Spring Webflux or WebMvc libraries.
33+
3234
- [WebFlux SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webflux) - Reactive HTTP streaming with Spring WebFlux (Client & Server)
3335
- [WebMvc SSE Transport](https://github.com/modelcontextprotocol/java-sdk/tree/main/mcp-spring/mcp-spring-webmvc) - Spring MVC based HTTP SSE transport (Server only).
3436
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
7173
- [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
7274
- [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
7375

74-
## Documentation
75-
76-
- [Java MCP SDK documentation](mcp/README.md)
77-
- [Reference documentation](docs/ref-index.md)
78-
7976

8077
## Development
8178

0 commit comments

Comments
 (0)