Udpate the README docs
This commit is contained in:
parent
800f145eb2
commit
683cf93d7e
1 changed files with 172 additions and 0 deletions
53
spring-ai-mcp-spring/README.md
Normal file
53
spring-ai-mcp-spring/README.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# Spring AI MCP Spring
|
||||
|
||||
Spring Integration module for Model Control Protocol (MCP) that provides Spring-specific functionality for working with MCP clients.
|
||||
|
||||
## Overview
|
||||
|
||||
The `spring-ai-mcp-spring` module is part of the [Spring AI MCP](https://github.com/spring-projects-experimental/spring-ai-mcp) project. It provides Spring Framework integration for the Model Control Protocol (MCP), enabling seamless integration of MCP functionality within Spring applications.
|
||||
|
||||
## Features
|
||||
|
||||
- Spring integration for MCP clients
|
||||
- Function callback implementation for tool invocations
|
||||
- Seamless integration with Spring AI's function calling capabilities
|
||||
|
||||
## Main Components
|
||||
|
||||
### McpFunctionCallback
|
||||
|
||||
The `McpFunctionCallback` class is the primary component of this module. It implements Spring AI's `FunctionCallback` interface and provides:
|
||||
|
||||
- Integration between Spring AI's function calling system and MCP tools
|
||||
- Automatic conversion between JSON and Java objects for tool arguments
|
||||
- Synchronous tool execution support
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Spring AI Core (`spring-ai-core`)
|
||||
- Spring AI MCP Core (`spring-ai-mcp-core`)
|
||||
|
||||
## Usage
|
||||
|
||||
To use this module, add the following dependency to your Maven project:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>org.springframework.experimental</groupId>
|
||||
<artifactId>spring-ai-mcp-spring</artifactId>
|
||||
<version>0.2.0-SNAPSHOT</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
||||
|
||||
## Links
|
||||
|
||||
- [GitHub Repository](https://github.com/spring-projects-experimental/spring-ai-mcp)
|
||||
- [Issue Tracker](https://github.com/spring-projects-experimental/spring-ai-mcp/issues)
|
||||
|
||||
## Contributing
|
||||
|
||||
This is an experimental Spring project. Contributions are welcome! Please refer to the main project's contribution guidelines.
|
||||
Loading…
Reference in a new issue