MCP Lucene Server

What is MCP Lucene Server?

MCP Lucene Server is a Java-based implementation of the Model Context Protocol (MCP) that provides efficient search and retrieval capabilities using Apache Lucene. It is built with Spring Boot and offers a RESTful API for managing and querying documents.

How to use MCP Lucene Server?

Clone the repository, build with Maven (mvn clean install), then run the JAR (java -jar target/mcp-lucene-server-0.0.1-SNAPSHOT.jar). Alternatively, build a Docker image (docker build -t mcp-lucene-server .) and run it (docker run -p 8080:8080 mcp-lucene-server). The server starts on port 8080 by default.

Key features of MCP Lucene Server

• Implements the core Model Context Protocol (MCP).
• Uses Apache Lucene for full-text indexing and search.
• Provides RESTful API with endpoints for document management.
• Supports upsert, delete, list, and status endpoints.
• Queries using Lucene syntax with optional metadata filtering.
• Built with Spring Boot; includes Docker deployment instructions.

Use cases of MCP Lucene Server

• Building a searchable document store with full-text indexing.
• Adding semantic or keyword-based query capabilities to MCP-based applications.
• Managing a local Lucene index via a lightweight REST API.
• Containerizing a search service for easy deployment.

FAQ from MCP Lucene Server

What are the prerequisites to run MCP Lucene Server?

Java 11 or higher and Maven 3.6.0 or higher are required. Docker is optional if using the Docker image.

How do I configure the Lucene index location?

Set the lucene.index.path property in application.properties or use an environment variable. If unset, a default location is used.

How do I run MCP Lucene Server with Docker?

Build the image with docker build -t mcp-lucene-server . and run it with docker run -p 8080:8080 mcp-lucene-server.

What query syntax does MCP Lucene Server support?

It supports complex queries using the standard Lucene query syntax, with optional filtering by document metadata fields.

What license does MCP Lucene Server use?

It is licensed under the Apache 2.0 License.