Solr MCP Server

🚀 Solr MCP Server

このSpring AI Model Context Protocol (MCP) サーバーは、Apache Solrとの対話ツールを提供します。このサーバーを使用すると、ClaudeのようなAIアシスタントがMCPプロトコルを通じてSolrコレクションの検索、インデックス作成、管理を行うことができます。

🚀 クイックスタート

このプロジェクトは、強力なオープンソース検索プラットフォームであるApache SolrとAIアシスタントが対話できる一連のツールを提供します。Spring AI MCPプロトコルを実装することで、Claude Desktopを含むすべてのMCP互換クライアントでこれらのツールを使用できます。プロジェクトでは、Solrの公式JavaクライアントであるSolrJを使用してSolrインスタンスと通信します。

✨ 主な機能

• 高度なクエリオプションでSolrコレクションを検索する
• Solrコレクションにドキュメントをインデックスする
• Solrコレクションを管理および監視する
• Solrスキーマ情報を取得して分析する

📦 インストール

前提条件

• Java 21以上
• DockerとDocker Compose (Solrを実行するため)
• Gradle (プロジェクトをビルドするため)

インストール手順

1. リポジトリをクローンする

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

2. Docker Composeを使用してSolrを起動する

docker-compose up -d

これにより、ZooKeeperを使用したSolrCloudモードでSolrインスタンスが起動し、2つのサンプルコレクションが作成されます。

• books - サンプルの書籍データを含むコレクション
• films - サンプルの映画データを含むコレクション

3. MCPサーバーをビルドして実行する

./gradlew bootRun

💻 使用例

基本的な使用法

Solrコレクションの検索

Tool: Search
Description: 指定されたSolrコレクションをクエリ、オプションのフィルター、ファセット、ソート、ページネーションで検索します。
Parameters:
  - collection: クエリするSolrコレクション
  - query: Solrのqパラメータ (指定されない場合は "*:*" がデフォルト)
  - filterQueries: Solrのfqパラメータ (オプション)
  - facetFields: Solrのファセットフィールド (オプション)
  - sortClauses: Solrのソートパラメータ (オプション)
  - start: ページネーションの開始オフセット (オプション)
  - rows: 返す行数 (オプション)

JSONドキュメントをSolrコレクションにインデックスする

Tool: index_documents
Description: JSON文字列からのドキュメントをSolrコレクションにインデックスします。
Parameters:
  - collection: インデックスするSolrコレクション
  - json: インデックスするドキュメントを含むJSON文字列

利用可能なすべてのSolrコレクションをリストする

Tool: listCollections
Description: Solrコレクションをリストします。
Parameters: なし

Solrコレクションの詳細な統計情報とメトリクスを取得する

Tool: getCollectionStats
Description: Solrコレクションの統計情報/メトリクスを取得します。
Parameters:
  - collection: コレクションの名前

Solrコレクションの健全性を確認する

Tool: checkHealth
Description: Solrコレクションの健全性を確認します。
Parameters:
  - collection: コレクションの名前

Solrコレクションのスキーマを取得する

Tool: getSchema
Description: Solrコレクションのスキーマを取得します。
Parameters:
  - collection: コレクションの名前

高度な使用法

Claude DesktopにこのMCPサーバーを追加する

1. プロジェクトをスタンドアロンのJARとしてビルドする

./gradlew bootJar

2. Claude Desktopで、[設定] > [ツール] > [ツールを追加] を選択する
3. ツールタイプとして "MCP Server" を選択する
4. ツールを構成する
   • 名前: Solr MCP Server
   • 説明: Apache Solrとの対話ツール
   • コマンド: java -jar /path/to/solr-mcp-server-0.0.1-SNAPSHOT.jar
   • 作業ディレクトリ: /path/to/solr-mcp-server
5. [ツールを追加] をクリックする

または、MCPクライアントの設定ファイルに以下の設定を追加することもできます。

"solr-search-mcp": {
  "command": "~/.sdkman/candidates/java/current/bin/java",
  "args": [
    "-jar",
    "~/solr-mcp-server/build/libs/solr-mcp-server-0.0.1-SNAPSHOT.jar"
  ],
  "env": {
    "SOLR_URL": "http://localhost:8983/solr/"
  }
}

注: Javaのインストールパスとプロジェクトの場所に合わせてパスを調整してください。

具体的な使用例

書籍を検索する

Solrコレクションでファンタジー書籍を検索する必要があります。手伝ってくれますか？

ClaudeはSearchツールを使用してbooksコレクションをクエリできます。

Solrコレクションでファンタジー書籍を検索します。

以下の設定でSearchツールを使用します。
- collection: books
- query: genre_s:fantasy
- rows: 5

見つかったファンタジー書籍は以下の通りです。
1. "A Game of Thrones" by George R.R. Martin
2. "A Clash of Kings" by George R.R. Martin
...

新しいドキュメントをインデックスする

Solrに追加したい新しい書籍データがあります。インデックスを作成してくれますか？

Claudeはindex_documentsツールを使用できます。

その書籍データをSolrにインデックスする手助けをします。

以下の設定でindex_documentsツールを使用します。
- collection: books
- json: [{"id":"123456789","name":["The New Book"],"author":["Jane Author"],"genre_s":"mystery","price":[12.99]}]

ドキュメントはbooksコレクションに正常にインデックスされました。

コレクションをリストする

システムで利用可能なSolrコレクションは何ですか？

ClaudeはlistCollectionsツールを使用できます。

利用可能なSolrコレクションを確認します。

listCollectionsツールを使用します。

利用可能なコレクションは以下の通りです。
1. books
2. films

コレクションの統計情報を取得する

'books'コレクションについてもっと詳しく教えてくれますか？サイズやその他のメトリクスが知りたいです。

ClaudeはgetCollectionStatsツールを使用できます。

'books'コレクションの統計情報を取得します。

以下の設定でgetCollectionStatsツールを使用します。
- collection: books

'books'コレクションの統計情報は以下の通りです。
- ドキュメント数: 1,245
- セグメント数: 5
- クエリパフォーマンス:
  - 平均クエリ時間: 12ms
  - キャッシュヒット率: 0.85
- ハンドラー統計情報:
  - 選択ハンドラーリクエスト: 1,532
  - 更新ハンドラーリクエスト: 245

コレクションの健全性を確認する

'films'コレクションは健全で正常に応答していますか？

ClaudeはcheckHealthツールを使用できます。

'films'コレクションの健全性を確認します。

以下の設定でcheckHealthツールを使用します。
- collection: films

健全性ステータス:
- 健全: はい
- 応答時間: 8ms
- 総ドキュメント数: 532
- 最終確認日時: 2023-06-15 14:32:45

スキーマ情報を取得する

'books'コレクションのスキーマで定義されているフィールドは何ですか？

ClaudeはgetSchemaツールを使用できます。

'books'コレクションのスキーマを取得します。

以下の設定でgetSchemaツールを使用します。
- collection: books

'books'コレクションには以下のフィールドが定義されています。
- id (string): 一意の識別子
- name (text_general): 書籍のタイトル
- author (text_general): 書籍の著者
- genre_s (string): ジャンル
- price (float): 書籍の価格
- in_stock_b (boolean): 書籍が在庫にあるかどうか
- publish_date (date): 出版日

トラブルシューティング

問題が発生した場合は、以下のことを確認してください。

1. Solrが実行されており、アクセス可能であることを確認する。デフォルトでは、サーバーはhttp://localhost:8983/solr/に接続しますが、SOLR_URL環境変数を設定することで別のSolrインスタンスを指定できます。
2. ログにエラーメッセージがないか確認する
3. Solr管理UIを使用してコレクションが存在することを確認する

📄 ライセンス

このプロジェクトは、Apache License 2.0の下でライセンスされています。

コントリビューション

コントリビューションは大歓迎です！プルリクエストを送信してください。