MCP Lucene Server

Description

The MCP Lucene Server is a Java-based implementation of the Model Context Protocol (MCP) designed to provide efficient search and retrieval capabilities using Apache Lucene. This server allows you to manage and query documents, leveraging Lucene's powerful indexing and search features. It is built using Spring Boot for easy setup and deployment.

Features

• MCP Compliance: Implements the core Model Context Protocol.
• Lucene-Powered: Utilizes Apache Lucene for full-text search and indexing.
• RESTful API: Provides a RESTful API for interacting with the server.
• Document Management:
  • Upsert: Add or update documents in the Lucene index.
  • Delete: Delete documents from the Lucene index.
  • List: Retrieve a list of documents from the index.
• Querying:
  • Supports complex queries using the Lucene query syntax.
  • Filtering: Filter queries based on document metadata.
• Status: Check the server status.
• Spring Boot: Built with Spring Boot for easy setup and deployment.
• Dockerization: Includes instructions for containerizing the application using Docker.

Getting Started# Prerequisites

• Java: Java 11 or higher.
• Maven: Maven 3.6.0 or higher.
• Docker: Install Docker if you plan to use the Docker image.

Installation

1. Clone the repository:

   git clone [https://github.com/your-username/mcp-lucene-server.git](https://github.com/your-username/mcp-lucene-server.git)
   cd mcp-lucene-server
   

   (Replace your-username with your GitHub username)
2. Build the project using Maven:

   mvn clean install
   

Running the Server## Without Docker

1. Run the Spring Boot application:

   java -jar target/mcp-lucene-server-0.0.1-SNAPSHOT.jar
   

   (The exact name of the .jar file might vary slightly depending on your project version.)
2. The server will start on port 8080 by default.

With Docker

1. Ensure you have Docker installed: Follow the instructions on the official Docker website: https://docs.docker.com/get-docker/
2. Build the Docker image: Navigate to the root directory of your project in your terminal and run:

   docker build -t mcp-lucene-server .
   

3. Run the Docker container:

   docker run -p 8080:8080 mcp-lucene-server
   

   This will map port 8080 on your host machine to port 8080 inside the container.

Usage# API Endpoints

The server provides the following API endpoints:

• GET /mcp/v1/status - Returns the status of the server.
• POST /mcp/v1/upsert - Upserts (inserts or updates) one or more documents.
• POST /mcp/v1/query - Queries the Lucene index.
• POST /mcp/v1/delete - Deletes documents from the Lucene index.
• GET /mcp/v1/list - Lists documents from the Lucene index.

Configuration

The server can be configured using Spring Boot's application properties. Here are some of the key properties:

• server.port: The port the server listens on (default: 8080).
• lucene.index.path: The path to the Lucene index directory.

License

This project is licensed under the Apache 2.0 License.