Spring Ai Example

🚀 Spring AI 示例プロジェクト

このプロジェクトは、Spring AIツールを使用した様々な実装パターンとベストプラクティスを示しています。主に2つのモジュールで構成されています。

• mcp-server：WebFluxとWebMvcをサポートするServer-Sent Events (SSE) のModel Context Protocol (MCP) サーバーを実装しています。
• proposal-agent：AIによる提案を生成するためのMCPクライアントを実装しています。

🚀 クイックスタート

このSpring AIのサンプルプロジェクトでは、Spring AIツールの使い方や実装パターンを学ぶことができます。以下のセクションで、詳細な情報を提供します。

✨ 主な機能

• 様々なSpring AIの実装パターンとベストプラクティスを展示します。
• MCPサーバーとクライアントの実装を含みます。
• ツールの定義、結果変換、コンテキスト管理、パラメータ設定などの機能を提供します。

📦 インストール

このプロジェクトはSpring Bootを使用しており、以下の手順で実行できます。

1. プロジェクトをクローンします。
2. 必要な依存関係をインストールします。
3. アプリケーションを起動します。

💻 使用例

基本的な使用法

メソッドをツールとして使用

Spring AIでは、@Tool アノテーションを使用してメソッドをツールとして定義できます。

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

ツール結果変換器

カスタムの結果変換器を実装して、ツールの結果の形式を制御できます。

@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データベース
• WebアクセスをサポートするためのCORS設定
• MCPサーバーとクライアントの実装
• リアルタイム更新用のSSE実装

📚 ドキュメント

プロジェクト構造

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

技術スタック

🔧 技術詳細

このプロジェクトでは、Spring AIを使用してAI関連の機能を実装しています。Spring AIは、ツールの定義、結果変換、コンテキスト管理、パラメータ設定などの機能を提供しています。また、Spring Bootを使用してアプリケーションを構築し、Ollama AIモデルを統合しています。ベクトルストレージにはPGVectorを使用し、開発用にH2データベースを使用しています。CORS設定を行うことでWebアクセスをサポートし、SSEを使用してリアルタイム更新を実現しています。