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 實現，用於即時更新

📚 技術棧