返回市场
麦克佩斯-春Boot服务器

麦克佩斯-春Boot服务器

作者:James-Zou6 星标更新:2025-03-29

项目介绍

技术文档摘要

MCP Spring Boot Server

License JDK Spring Boot Author

这是一个基于Model Context Protocol (MCP)的Spring Boot服务器实现,通过MCP接口提供气象信息服务。

特性

  • 通过MCP提供气象信息服务
  • 支持RESTful API端点
  • 支持服务器发送事件(SSE)
  • 自动工具注册
  • 集成Spring Boot 3.x

要求

  • JDK 11或更高版本
  • Maven 3.6.x或更高版本
  • Spring Boot 3.2.0或更高版本

快速开始

克隆仓库

git clone https://github.com/yourusername/mcp-springboot-server.git
cd mcp-springboot-server

构建项目

mvn clean install

运行应用

mvn spring-boot:run

默认情况下,服务器将在8080端口启动。

配置

主要配置属性位于application.properties文件中:

server.port=8080
spring.application.name=mcp-demo
spring.ai.mcp.server.enabled=true

更多配置选项,请查看application.properties文件。

API文档

气象服务

气象服务提供了以下MCP方法:

  • getWeather(String cityName): 获取特定城市的气象信息
  • getWeather1(String cityName): 获取气象信息的替代方法

示例用法在测试客户端中:

var transport = new HttpClientSseClientTransport("http://localhost:8080");
var client = McpClient.sync(transport).build();

项目结构

src/
├── main/
│   ├── java/
│   │   └── com/unionhole/mcpserver/
│   │       ├── config/
│   │       ├── service/
│   │       └── McpDemoApplication.java
│   └── resources/
│       └── application.properties
└── test/
    └── java/
        └── com/unionhole/mcpserver/
            └── ClientSseTest.java

贡献指南

  1. 分叉仓库
  2. 创建功能分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 打开Pull Request

许可证

本项目采用Apache License 2.0许可 - 详情请参阅LICENSE文件。

作者

James Zou

致谢

  • Spring Boot 团队
  • Model Context Protocol 团队
  • 所有对此项目做出贡献的人

框架说明

1. Maven 依赖配置

项目使用了以下主要依赖:

<dependencies>
    <!-- Spring AI 核心 -->
    <dependency>
        <groupId>org.springframework.ai</groupId>
        <artifactId>spring-ai-core</artifactId>
        <version>${spring-ai.version}</version>
    </dependency>

    <!-- MCP 服务器 WebMVC -->
    <dependency>
        <groupId>org.springframework.ai</groupId>
        <artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
        <version>${spring-ai.version}</version>
    </dependency>
    <!-- 添加 MCP Facade 生成器依赖 -->
    <dependency>
        <groupId>com.unionhole</groupId>
        <artifactId>mcp-facade-generator</artifactId>
        <version>${mcp-facade.version}</version>
    </dependency>
</dependencies>

2. MCP 配置说明

application.properties 中配置 MCP 服务器:

# MCP 服务器配置
spring.ai.mcp.server.enabled=true
spring.ai.mcp.server.resource-change-notification=true
spring.ai.mcp.server.prompt-change-notification=true
spring.ai.mcp.server.tool-change-notification=true
spring.ai.mcp.server.name=mcp-demo-service
spring.ai.mcp.server.version=1.0.0
spring.ai.mcp.server.type=SYNC
spring.ai.mcp.server.sse-message-endpoint=/mcp/messages

3. MCP Tools 配置

通过 McpServerConfig 类配置 MCP Tools:

@Configuration
public class McpServerConfig {
    @Bean
    public ToolCallbackProvider autoRegisterTools(ApplicationContext applicationContext) {
        // 获取所有带有 @Component 注解且类名以 Facade 结尾的 bean
        String[] beanNames = applicationContext.getBeanNamesForAnnotation(Component.class);
        List<Object> facadeBeans = new ArrayList<>();
        for (String beanName : beanNames) {
            if (beanName.endsWith("Facade")) {
                facadeBeans.add(applicationContext.getBean(beanName));
            }
        }
        return MethodToolCallbackProvider.builder()
                .toolObjects(facadeBeans.toArray())
                .build();
    }
}

4. 业务服务开发

  1. 创建服务类并添加 @MCPService 注解:
@MCPService
@Service
public class WeatherService {
    public String getWeather(String cityName) {
        // 实现业务逻辑
        return "Weather info for " + cityName;
    }
}
  1. 使用 @MCPMethod 注解标记需要暴露的方法:
@MCPMethod(description = "获取天气信息")
public String getWeather(String cityName) {
    // 方法实现
}

5. 客户端测试

使用提供的 ClientSseTest 类进行测试:

public class ClientSseTest {
    public static void main(String[] args) {
        var transport = new HttpClientSseClientTransport("http://localhost:8080");
        var client = McpClient.sync(transport).build();

        try {
            client.initialize();
            client.ping();

            // 列出可用的工具
            McpSchema.ListToolsResult toolsList = client.listTools();
            System.out.println("Available Tools = " + toolsList);

            client.closeGracefully();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

注意事项

  1. 确保正确配置了 Spring AI 和 MCP 的版本
  2. 所有 Facade 类都应该使用 @Component 注解
  3. 建议使用 @MCPMethod 注解来提供方法的描述信息
  4. 异常处理应该在服务层统一处理

常见问题解决

1. 编译时出现 IllegalArgumentException

如果在编译过程中遇到以下错误:

java: java.lang.IllegalArgumentException

解决方案:

在 IntelliJ IDEA 中添加 VM 选项:

  1. 打开 Settings (Ctrl + Alt + S)
  2. 导航到 Build, Execution, Deployment > Compiler
  3. 在 "Build process VM options" 字段中添加:
    -Djps.track.ap.dependencies=false
    
  4. 点击 Apply 和 OK
  5. 重新构建项目

参考文档


版权所有 © 2024 James Zou. 保留所有权利。