1 Star 3 Fork 3

facedog/server2mcp

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Server2MCP Spring Boot Starter

English

这绝对是一个革命性的想法!!!

这是一个用于自动化集成 MCP (Model Control Protocol) 服务的 Spring Boot Starter。

✨功能特性

  • 自动配置 MCP 服务,类似mybatis-plus于mybatis的关系,无侵入,纯增强
  • 支持一切mcp的javaSdk原生功能,提供工具注册和回调机制等等
  • 支持自定义 工具注册,通过@ToolScan注解
  • 用户可自定义Parser,而无关责任链实现,完成独特接口注解的属性解析
  • 拥有javadoc,swagger2,swagger3,springmvc(只负责部分解析逻辑),jackson 以及springai原生的tool 解析器

👀未完善点

已经具有较为成熟的解析逻辑,目前主流解析逻辑已经较为完善,如果有我没考虑到的,欢迎踊跃交流,后续将会提供强有力的自定义扩展功能,用户可以通过简单的配置类等方式,来完成自定义注释注解的解析。

🎯快速开始

因为还没有推到中心仓库,可以把源码下载下来之后,在 server2mcp-starter-webmvc 文件夹下 进行 mvn clean install 后进行依赖引用

添加依赖

<dependency>
    <groupId>com.ai.plug</groupId>
    <artifactId>server2mcp-starter-webmvc</artifactId>
    <version>1.0.0</version>
</dependency>

然后在配置文件中添加配置:

plugin:
  mcp:
    enabled: true
    parser:
      param: JAVADOC, TOOL, SPRINGMVC, JACKSON, SWAGGER2, SWAGGER3  # 可不填 ,默认注册除JAVADOC之外的解析器
      des:  JAVADOC, TOOL, JACKSON, SWAGGER3, SWAGGER2     # 可不填 ,默认注册除JAVADOC之外的解析器
    scope: interface # 有两种配置,custom和interface,默认interface,会预先注册controller下的接口为工具;custom 则不会预先注册工具

以上就是该项目启动的最基本配置,它包含了所有的原生配置如spring.ai.mcp.server.name等等,interface配置它默认会将你的所有启动类路径下的所有controller注册为mcp接口,如果接口方法或类上有@Deprecated注解将不会注册。

注意:JAVADOC解析器

javadoc的解析逻辑本质上就是通过解析源码文件,而上线之后java代码是以字节码 class文件的形式存在,所以javadoc就无法使用,但是javadoc的注解方式在开发者中间还是比较流行的,所以不能够完全舍弃。现给出解决方案,要使用javadoc方式的解析器,必须将源码打包到资源目录里,如果你使用maven,需要加一段打包配置,如下所示:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <executions>
                    <execution>
                        <id>copy-java-sources</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${project.build.outputDirectory}</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>src/main/java</directory>
                                    <includes>
                                        <include>**/*.java</include>
                                    </includes>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            

📚原理

可以理解为把接口开放给ai,所以这些接口和普通接口一样,只是可以通过ai调用,相关知识文档:Model Context Protocol (MCP) :: Spring AI Reference Introduction - Model Context Protocol

💕最佳实践

拥有了该框架,你不必再去从0-1重新建造一个mcp服务应用,也不必高耦合的复制代码添加@Tool注解,或者在源代码上添加mcp功能,你只需要根据一个配置类添加自定义的@ToolScan注解,就可以轻松的完成mcp接口的注册,如果遇到mcp的SDK 改版怎么办,这不用担心,核心内容由我维护,且使用方式不变

1. 你可以轻松的去构建一个多智能体应用,只需要多个你自定义的ai对话接口,然后只需要在客户端进行相应的mcp接口调用即可轻松完成。

2. 可以为你的管理系统,快速接入ai对话调用,高自定义性,你无需关注任何ai领域细节,只需要关注你最擅长的领域web及前端,就可以完成炫酷的效果,这样一比,DB-GPT这样的应用是不是显得高度笨重且难以扩展

3. 可以配合cursor这种简易的mcp客户端,轻松的完成接口调试

🔔总结

这个框架实际上非常简单,可能代码有很多漏洞与不足,还请见谅。

📄 版权声明/开源协议

根据 Apache 2.0 许可证发布的代码

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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 http://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.

简介

这是一个革命性的MCP插件,具有出色的可插拔和封装功能。只需几行配置,它就可以很容易地集成到您的Spring引导web程序中,并为其提供MCP功能,优良的继承了spring系列框架强大的工程化能力,让javaSdk成为mcp开发首选 展开 收起
README
Apache-2.0
取消

发行版 (1)

全部
22天前

贡献者

全部

语言

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/facedog/server2mcp.git
git@gitee.com:facedog/server2mcp.git
facedog
server2mcp
server2mcp
master

搜索帮助