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: Add MCP SDK documentation and architecture diagrams

Browse source 
Add comprehensive documentation for the MCP Java SDK implementation
Add architecture diagrams showing layered design and class relationships
Reorganize documentation structure with dedicated pages for:
Overview and introduction
MCP Java SDK reference
Spring AI MCP integration
Include detailed examples and usage patterns for both sync and async APIs
This commit is contained in:
Christian Tzolov 2025-01-03 00:25:41 +01:00
commit 48fad96fe4
1 changed files with 718 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

54
mcp-docs/src/main/antora/modules/ROOT/pages/index2.adoc
View file

@ -1,54 +0,0 @@
= Spring AI MCP Spring
:page-title: Spring AI MCP Spring
:doctype: book
:icons: font
:source-highlighter: highlight.js
:toc: left
Spring Integration module for Model Control Protocol (MCP) that provides Spring-specific functionality for working with MCP clients.
== Overview
The `spring-ai-mcp` module is part of the https://github.com/spring-projects-experimental/spring-ai-mcp[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
== Usage
To use this module, add the following dependency to your Maven project:
[source,xml]
----
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-ai-mcp</artifactId>
<version>0.4.0-SNAPSHOT</version>
</dependency>
----
== License
This project is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache License 2.0].
== Links
* https://github.com/spring-projects-experimental/spring-ai-mcp[GitHub Repository]
* https://github.com/spring-projects-experimental/spring-ai-mcp/issues[Issue Tracker]
== Contributing
This is an experimental Spring project. Contributions are welcome! Please refer to the main project's contribution guidelines.