Skip to content
This repository was archived by the owner on Feb 14, 2025. It is now read-only.

Commit a2a8be2

Browse files
committed
Improve README
1 parent d96222d commit a2a8be2

File tree

1 file changed

+8
-22
lines changed

1 file changed

+8
-22
lines changed

README.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Java SDK for the Model Context Protocol (MCP), providing seamless integration be
44

55
## Overview
66

7-
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.
7+
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.
88

99
<img src="docs/spring-ai-mcp-architecture.jpg" width="600">
1010

@@ -14,8 +14,8 @@ The project consists of two main modules:
1414

1515
### [mcp](./mcp/README.md)
1616

17-
The core module provides a Java implementation of the Model Context Protocol specification. It includes:
18-
- Synchronous and asynchronous client implementations
17+
Java implementation of the Model Context Protocol specification. It includes:
18+
- 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
1919
- Standard MCP operations support (tool discovery, resource management, prompt handling). Support for request and notificaiotn handling.
2020
- [Stdio](https://spec.modelcontextprotocol.io/specification/basic/transports/#stdio) and [SSE](https://spec.modelcontextprotocol.io/specification/basic/transports/#http-with-sse) transport implementations.
2121
- [Find more](./mcp/README.md).
@@ -61,12 +61,13 @@ Explore these MCP examples in the [spring-ai-examples/model-context-protocol](ht
6161
- [SQLite Chatbot](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/sqlite/chatbot) - Interactive chatbot with SQLite database interaction
6262
- [Filesystem](https://github.com/spring-projects/spring-ai-examples/tree/main/model-context-protocol/filesystem) - Enables LLM interaction with local filesystem folders and files
6363
- [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.
64-
64+
- [Spring-ai-mcp-sample](./spring-ai-mcp-sample/) - Showcases how to create and use MCP servers and clients with different transport modes and capabilities.
6565
## Documentation
6666

67-
- [Core Module Documentation](mcp/README.md)
68-
- [Spring Integration Documentation](spring-ai-mcp/README.md)
69-
- [UML Class Diagrams](spring-ai-mcp/docs/spring-ai-mcp-uml-classdiagram.svg)
67+
- [Java MCP SDK documentation](mcp/README.md)
68+
- [Reference documentation](docs/ref-index.md)
69+
- [Spring Integration documentation](spring-ai-mcp/README.md)
70+
7071

7172
## Development
7273

@@ -111,18 +112,3 @@ This is an experimental Spring project. Contributions are welcome! Please:
111112
## License
112113

113114
This project is licensed under the [Apache License 2.0](LICENSE).
114-
115-
```
116-
Copyright 2024-2024 the original author or authors.
117-
118-
Licensed under the Apache License, Version 2.0 (the "License");
119-
you may not use this file except in compliance with the License.
120-
You may obtain a copy of the License at
121-
122-
https://www.apache.org/licenses/LICENSE-2.0
123-
124-
Unless required by applicable law or agreed to in writing, software
125-
distributed under the License is distributed on an "AS IS" BASIS,
126-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
127-
See the License for the specific language governing permissions and
128-
limitations under the License.

0 commit comments

Comments
 (0)