Improve README
This commit is contained in:
parent
d96222dcaf
commit
a2a8be2155
1 changed files with 8 additions and 22 deletions
30
README.md
30
README.md
|
|
@ -4,7 +4,7 @@ Java SDK for the Model Context Protocol (MCP), providing seamless integration be
|
|||
|
||||
## Overview
|
||||
|
||||
Experimental project that provides Java and Spring Framework integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture). It enables Java applications to interact with AI models and tools through a standardized interface, supporting both synchronous and asynchronous communication patterns.
|
||||
Provides Java and Spring Framework integration for the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture). It enables Java applications to interact with AI models and tools through a standardized interface, supporting both synchronous and asynchronous communication patterns.
|
||||
|
||||
<img src="docs/spring-ai-mcp-architecture.jpg" width="600">
|
||||
|
||||
|
|
@ -14,8 +14,8 @@ The project consists of two main modules:
|
|||
|
||||
### [mcp](./mcp/README.md)
|
||||
|
||||
The core module provides a Java implementation of the Model Context Protocol specification. It includes:
|
||||
- Synchronous and asynchronous client implementations
|
||||
Java implementation of the Model Context Protocol specification. It includes:
|
||||
- Synchronous and asynchronous [MCP Client](https://github.com/spring-projects-experimental/spring-ai-mcp/blob/main/mcp/README.md#client-usage-examples) and [MCP Server](https://github.com/spring-projects-experimental/spring-ai-mcp/blob/main/mcp/README.md#server-usage-examples) implementations
|
||||
- Standard MCP operations support (tool discovery, resource management, prompt handling). Support for request and notificaiotn handling.
|
||||
- [Stdio](https://spec.modelcontextprotocol.io/specification/basic/transports/#stdio) and [SSE](https://spec.modelcontextprotocol.io/specification/basic/transports/#http-with-sse) transport implementations.
|
||||
- [Find more](./mcp/README.md).
|
||||
|
|
@ -61,12 +61,13 @@ Explore these MCP examples in the [spring-ai-examples/model-context-protocol](ht
|
|||
- [SQLite Chatbot](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/sqlite/chatbot) - Interactive chatbot with SQLite database interaction
|
||||
- [Filesystem](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/filesystem) - Enables LLM interaction with local filesystem folders and files
|
||||
- [Brave](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/brave) - Enables natural language interactions with Brave Search, allowing you to perform internet searches.
|
||||
|
||||
- [Spring-ai-mcp-sample](./spring-ai-mcp-sample/) - Showcases how to create and use MCP servers and clients with different transport modes and capabilities.
|
||||
## Documentation
|
||||
|
||||
- [Core Module Documentation](mcp/README.md)
|
||||
- [Spring Integration Documentation](spring-ai-mcp/README.md)
|
||||
- [UML Class Diagrams](spring-ai-mcp/docs/spring-ai-mcp-uml-classdiagram.svg)
|
||||
- [Java MCP SDK documentation](mcp/README.md)
|
||||
- [Reference documentation](docs/ref-index.md)
|
||||
- [Spring Integration documentation](spring-ai-mcp/README.md)
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
|
|
@ -111,18 +112,3 @@ This is an experimental Spring project. Contributions are welcome! Please:
|
|||
## License
|
||||
|
||||
This project is licensed under the [Apache License 2.0](LICENSE).
|
||||
|
||||
```
|
||||
Copyright 2024-2024 the original author or authors.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
|
|||
Loading…
Reference in a new issue