MCP Lucene Server

🚀 MCP Lucene サーバー

MCP Lucene サーバーは、Java ベースの Model Context Protocol (MCP) の実装です。Apache Lucene を利用して、効率的な検索とドキュメントの管理を提供します。このサーバーを使うことで、ドキュメントの挿入、検索、削除、リスト表示などの操作が可能です。

🚀 クイックスタート

前提条件

• Java Development Kit (JDK) 1.8 以上
• プロジェクト管理に Maven またはその他のビルドツール

インストール手順

1. リポジトリのクローン

   git clone https://github.com/your-repository/mcp-lucene.git
   cd mcp-lucene
   

2. プロジェクトのビルド Maven を使用してビルドします。

   mvn clean install
   

3. サーバーの起動

   java -jar target/mcp-lucene.jar
   

✨ 主な機能

• 挿入または更新（Upsert）：複数のドキュメントを含む JSON 配列をアップロードします。
• 検索（Query）：テキスト内容とオプションのフィルタ条件に基づいてドキュメントを検索します。返される結果の数の上限を指定でき、デフォルトは 10 です。
• 削除（Delete）：ドキュメント ID のリストを指定して、特定のドキュメントをインデックスから削除します。
• リスト表示（List）：ドキュメント ID のリストを指定して、特定のドキュメントの内容を取得します。

💻 使用例

基本的な使用法

サーバーの状態を取得する

curl http://localhost:8080/mcp/v1/status

ドキュメントを挿入する

curl -X POST \
http://localhost:8080/mcp/v1/upsert \
-H 'Content-Type: application/json' \
-d '
{
  "documents": [
    {
      "id": "doc1",
      "text": "这是第一个文档。",
      "metadata": {
        "类别": "示例",
        "语言": "中文"
      }
    },
    {
      "id": "doc2",
      "text": "这是第二个文档。",
      "metadata": {
        "类别": "测试",
        "语言": "中文"
      }
    }
  ]
}'

ドキュメントを検索する

curl -X POST \
http://localhost:8080/mcp/v1/query \
-H 'Content-Type: application/json' \
-d '
{
  "queries": [
    {
      "query": "测试",
      "top_k": 3,
      "filter": {
        "语言": "中文"
      }
    }
  ]
}'

ドキュメントを削除する

curl -X POST \
http://localhost:8080/mcp/v1/delete \
-H 'Content-Type: application/json' \
-d '
{
  "ids": ["doc1"]
}'

ドキュメントをリスト表示する

curl -X POST \
http://localhost:8080/mcp/v1/list \
-H 'Content-Type: application/json' \
-d '
{
  "ids": ["doc1", "doc2"]
}'

高度な使用法

サーバーの起動方法

ローカルでの起動

サーバーを起動すると、デフォルトで http://localhost:8080 ポートで待機します。

Docker でのデプロイ

1. イメージのパッケージング：

   FROM java:8-jdk
   COPY target/mcp-lucene.jar /app/
   WORKDIR /app
   ENTRYPOINT ["java", "-jar", "mcp-lucene.jar"]
   

2. ビルドと実行：

   docker build -t mcp-lucene .
   docker run -p 8080:8080 mcp-lucene
   

インターフェースの説明

• ドキュメントの挿入または更新：

  POST /mcp/v1/upsert
  Content-Type: application/json
  
  {
    "documents": [
      {
        "id": "doc1",
        "text": "这是第一个文档的内容。",
        "metadata": {
          "类别": "示例",
          "语言": "中文"
        }
      },
      ...
    ]
  }
  

• ドキュメントの検索：

  POST /mcp/v1/query
  Content-Type: application/json
  
  {
    "queries": [
      {
        "query": "搜索关键词",
        "top_k": 5,
        "filter": {
          "语言": "中文"
        }
      }
    ]
  }
  

• ドキュメントの削除：

  POST /mcp/v1/delete
  Content-Type: application/json
  
  {
    "ids": ["doc1", "doc2"]
  }
  

• ドキュメントのリスト表示：

  POST /mcp/v1/list
  Content-Type: application/json
  
  {
    "ids": ["doc1", "doc2"]
  }
  

📚 ドキュメント

設定

application.properties ファイルを使用してサーバーの属性を設定できます。

• ポート：サーバーが待機するポート番号を指定します。デフォルトは 8080 です。
• スレッド数：リクエストを処理する最大スレッド数を設定します。ハードウェアリソースに応じて調整することをおすすめします。

設定例：

server.port=8081
server.servlet.thread-count=20

プロジェクト構造

mcp-lucene/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/MCPServer.java
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│       └── JavaTestCases.java
└── pom.xml

依存関係管理

このプロジェクトは Maven を使用して依存関係を管理しています。主要な依存関係は以下の通りです。

開発ガイド

1. コード構造：

   • MCPServer.java：メインサービスクラスで、起動ロジックと REST インターフェースの定義が含まれています。
   • DocumentService.java：ドキュメントの保存と検索のビジネスロジックを実装しています。

2. 単体テスト： JUnit と Mockito を使用して単体テストを行い、各機能モジュールが正常に動作することを確認します。

📄 ライセンス

このプロジェクトは Apache License 2.0 ライセンスに準拠しています。詳細は LICENSE ファイルを参照してください。