Spring Ai Example

🚀 Spring AI 示例项目

本项目展示了运用 Spring AI 工具的各类实现模式与最佳实践。通过两个主要模块，为开发者提供了使用 Spring AI 的清晰范例，助力其在实际项目中更好地运用相关技术。

🚀 快速开始

本项目包含两个主要模块：

• mcp-server：实现了支持 WebFlux 和 WebMvc 的 Server-Sent Events (SSE) 的 Model Context Protocol (MCP) 服务器。
• proposal-agent：实现了 MCP 客户端，用于生成 AI 驱动的建议。

📦 项目结构

.
├── mcp-server/           # MCP 服务器实现
│   ├── src/             # 服务器源代码
│   └── README.md        # 服务器文档
├── proposal-agent/      # MCP 客户端实现
│   ├── src/             # 客户端源代码
│   └── README.md        # 客户端文档
└── src/                 # 公共源代码

💻 使用示例

基础用法

方法作为工具

Spring AI 支持通过使用 @Tool 注解将方法定义为工具。例如，来自 DateTimeTools 的以下方法：

@Tool(name = "getCurrentDateTime", description = "获取当前日期和时间")
public String getCurrentDateTime() {
    return LocalDateTime.now().atZone(LocaleContextHolder.getTimeZone().toZoneId()).toString();
}

工具结果转换器

可以实现自定义结果转换器来控制工具结果的格式。例如，来自 CustomToolCallResultConverter 的以下方法：

@Tool(name = "getCustomer",
      description = "检索客户信息",
      resultConverter = CustomToolCallResultConverter.class)
public Customer getCustomer(String name, ToolContext context) {
    return new Customer(name, "example@email.com");
}

工具上下文

Spring AI 提供了一个 ToolContext 参数，可以注入到工具方法中以访问上下文信息：

public Customer getCustomerByEmail(String email, ToolContext context) {
    log.info("上下文: {}", context);
    return new Customer("Demo", email);
}

工具参数

可以通过在工具参数上使用 @ToolParam 注解来提供描述。例如，来自以下方法的示例：

@Tool(name = "setAlarm")
public void setAlarm(@ToolParam(description = "ISO-8601 格式的日期时间") String time) {
    // 实现
}

🔧 配置

该项目使用 Spring Boot，并配置了以下关键设置：

• Ollama AI 模型集成
• 向量存储（PGVector）
• H2 数据库用于开发
• CORS 配置以支持 Web 访问
• MCP 服务器实现
• MCP 客户端实现
• SSE 实现，用于实时更新

📚 技术栈