基本能力
产品定位
MCP Lucene Server 是一个基于 Apache Lucene 的全文搜索服务,旨在提供高效的文档索引和检索功能。
核心功能
- MCP 合规性:实现核心 Model Context Protocol。
- Lucene 支持:利用 Apache Lucene 进行全文搜索和索引。
- RESTful API:提供 RESTful API 进行交互。
- 文档管理:支持文档的增删改查(Upsert、Delete、List)。
- 查询功能:支持复杂查询和基于元数据的过滤。
- 状态检查:提供服务器状态检查接口。
- Spring Boot 集成:基于 Spring Boot 构建,易于部署。
- Docker 支持:支持 Docker 容器化部署。
适用场景
- 需要高效全文搜索的应用。
- 文档管理系统。
- 需要复杂查询和过滤功能的服务。
工具列表
- Apache Lucene:提供全文搜索和索引功能。
- Spring Boot:简化服务器部署和配置。
- Docker:支持容器化部署。
常见问题解答
- 如何配置 Lucene 索引路径?:通过
lucene.index.path
配置项设置。 - 如何修改服务器端口?:通过
server.port
配置项设置。
使用教程
使用依赖
- Java:Java 11 或更高版本。
- Maven:Maven 3.6.0 或更高版本。
- Docker(可选):用于容器化部署。
安装教程
- 克隆仓库:
bash
git clone https://github.com/your-username/mcp-lucene-server.git
cd mcp-lucene-server - 构建项目:
bash
mvn clean install
运行服务器
不使用 Docker
bash
java -jar target/mcp-lucene-server-0.0.1-SNAPSHOT.jar
使用 Docker
- 构建 Docker 镜像:
bash
docker build -t mcp-lucene-server . - 运行 Docker 容器:
bash
docker run -p 8080:8080 mcp-lucene-server
调试方式
- 检查服务器状态:
bash
curl http://localhost:8080/mcp/v1/status - 测试文档操作:参考 README 中的示例命令。