servidor mcp-lucene

Servidor MCP Lucene

Descripción

El servidor MCP Lucene es una implementación basada en Java del Protocolo de Contexto de Modelo (MCP), diseñado para proporcionar funciones eficientes de búsqueda y recuperación mediante Apache Lucene. Este servidor permite gestionar y consultar documentos, aprovechando las potentes funciones de indexación y búsqueda de Lucene. Está desarrollado con Spring Boot para facilitar su configuración e implementación.

Características

Cumplimiento de MCP: implementa el protocolo de contexto de modelo principal.
Impulsado por Lucene: utiliza Apache Lucene para búsqueda e indexación de texto completo.
API RESTful: proporciona una API RESTful para interactuar con el servidor.
Gestión de documentos:
- Upsert: agrega o actualiza documentos en el índice de Lucene.
- Eliminar: elimina documentos del índice de Lucene.
- Lista: recupera una lista de documentos del índice.
Consultando:
- Admite consultas complejas utilizando la sintaxis de consulta de Lucene.
- Filtrado: Filtrar consultas en función de los metadatos del documento.
Estado: Verifique el estado del servidor.
Spring Boot: desarrollado con Spring Boot para una fácil configuración e implementación.
Dockerización: incluye instrucciones para contenerizar la aplicación usando Docker.

Empezando

Prerrequisitos

Java: Java 11 o superior.
Maven: Maven 3.6.0 o superior.
Docker: instale Docker si planea utilizar la imagen de Docker.

Instalación

Clonar el repositorio:
git clone [https://github.com/your-username/mcp-lucene-server.git](https://github.com/your-username/mcp-lucene-server.git) cd mcp-lucene-server
(Reemplace your-username con su nombre de usuario de GitHub)
Construya el proyecto usando Maven:
mvn clean install

Ejecución del servidor

Sin Docker

Ejecute la aplicación Spring Boot:
java -jar target/mcp-lucene-server-0.0.1-SNAPSHOT.jar
(El nombre exacto del archivo .jar puede variar levemente dependiendo de la versión de su proyecto).
El servidor se iniciará en el puerto 8080 de forma predeterminada.

Con Docker

Asegúrese de tener Docker instalado: siga las instrucciones en el sitio web oficial de Docker: https://docs.docker.com/get-docker/
Construya la imagen de Docker: navegue al directorio raíz de su proyecto en su terminal y ejecute:
docker build -t mcp-lucene-server .
Ejecute el contenedor Docker:
docker run -p 8080:8080 mcp-lucene-server
Esto asignará el puerto 8080 en su máquina host al puerto 8080 dentro del contenedor.

Uso

Puntos finales de API

El servidor proporciona los siguientes puntos finales de API:

GET /mcp/v1/status
- Devuelve el estado del servidor.
POST /mcp/v1/upsert
- Upserts (inserta o actualiza) uno o más documentos.
- Cuerpo de la solicitud:
  { "documents": [ { "id": "doc1", "text": "This is the text of document 1.", "metadata": { "category": "example", "language": "english" } }, { "id": "doc2", "text": "This is document 2's text.", "metadata": { "category": "sample", "language": "spanish" } } ] }
POST /mcp/v1/query
- Consulta el índice de Lucene.
- Cuerpo de la solicitud:
  { "queries": [ { "query": "document", "top_k": 10, "filter": { "language": "english" } }, { "query": "text search", "filter": { "category": "example" } } ] }
- query : La cadena de consulta de Lucene.
- top_k : (opcional) El número máximo de resultados a devolver (predeterminado: 10).
- filter : (opcional) Un mapa de campos de metadatos y valores para filtrar.
POST /mcp/v1/delete
- Elimina documentos del índice de Lucene.
- Cuerpo de la solicitud:
  { "ids": ["doc1", "doc2"] }
GET /mcp/v1/list
- Enumera documentos del índice de Lucene.
- Cuerpo de la solicitud:
  { "ids": ["doc1", "doc2"] }

Ejemplos

Obtener el estado del servidor:

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

Insertar documentos:

curl -X POST 

http://localhost:8080/mcp/v1/upsert 

-H 'Content-Type: application/json' 

-d '{
"documents": [
{
"id": "doc1",
"text": "This is the text of document 1.",
"metadata": {
"category": "example",
"language": "english"
}
},
{
"id": "doc2",
"text": "This is document 2''s text.",
"metadata": {
"category": "sample",
"language": "spanish"
}
}
]
}'

Consulta de documentos:

curl -X POST 

http://localhost:8080/mcp/v1/query 

-H 'Content-Type: application/json' 

-d '{
"queries": [
{
"query": "document text",
"top_k": 5,
"filter": {
"language": "english"
}
}
]
}'

Eliminar documentos:

curl -X POST 

http://localhost:8080/mcp/v1/delete 

-H 'Content-Type: application/json' 

-d '{
"ids": ["doc1"]
}'

Lista de documentos:

curl -X POST 

http://localhost:8080/mcp/v1/list 

-H 'Content-Type: application/json' 

-d '{
"ids": ["doc1", "doc2"]
}'

Configuración

El servidor se puede configurar mediante las propiedades de la aplicación Spring Boot. Estas son algunas de las propiedades clave:

server.port : el puerto en el que escucha el servidor (predeterminado: 8080).
lucene.index.path : La ruta al directorio de índice de Lucene. Aquí se almacenan los datos indexados. Si no se configura, se utiliza una ubicación predeterminada. Se recomienda configurarla como una ubicación de almacenamiento persistente.

Puede configurar estas propiedades en un archivo application.properties o application.yml en su directorio src/main/resources , o mediante variables de entorno.

Ejemplo application.properties :

servidor.puerto=8080 lucene.index.path=/ruta/a/lucene/index

Licencia

Este proyecto está licenciado bajo la licencia Apache 2.0 .

mcp-lucene-server

Integrations