Add doc diagrams

This commit is contained in:
Christian Tzolov 2024-12-11 00:51:13 +01:00
commit a922b1aa7a

View file

@ -30,6 +30,12 @@ Add the following dependency to your Maven project:
</dependency>
```
## Documentation
Detailed UML class diagrams showing the relationships between components can be found in [docs/class-diagrams.puml](docs/class-diagrams.puml). The diagrams include:
- Core Components: Shows the main interfaces, classes, and their relationships
- Message Flow: Illustrates the message and resource type hierarchies
## Usage
### Async Client Example
@ -135,6 +141,8 @@ The SDK follows a layered architecture:
- **AbstractMcpTransport**: Base transport implementation
- **StdioServerTransport**: Stdio-based server communication
<img src="docs/spring-ai-mcp-uml-classdiagram.svg" width="600"/>
### Key Interactions
1. Client initialization