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

docs(mcp) add class diagram

Browse source
This commit is contained in:
Christian Tzolov 2024-12-29 00:25:24 +01:00
commit bc75b27e53
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
mcp/README.md
View file

@ -42,6 +42,10 @@ The SDK follows a layered architecture with clear separation of concerns:
- **Session Layer (McpSession)**: Manages communication patterns and state using DefaultMcpSession implementation.
- **Client/Server Layer**: Both use McpSession for sync/async operations, with McpClient handling client-side protocol operations and McpServer managing server-side protocol operations.
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.
<img src="../docs/spring-ai-mcp-uml-classdiagram.svg" width="600"/>
### Key Interactions
- **Client/Server Initialization**: Transport setup, protocol compatibility check, capability negotiation, and implementation details exchange.
@ -50,6 +54,7 @@ The SDK follows a layered architecture with clear separation of concerns:
- **Prompt System**: Discovery, parameter-based retrieval, change notifications, and content management.
- **Tool Execution**: Discovery, parameter validation, timeout-aware execution, and result processing.
## Client Usage Examples
### MCP Client (Sync API)