使用说明

项目简介

Fess MCP Server 是一个桥接 Fess 开源搜索引擎和 MCP 兼容的 LLM 客户端（如 Claude for Desktop）的中间件。它允许 LLM 利用 Fess 搜索和检索可能不在公共网络上公开的信息，从而扩展 LLM 的知识范围，使其能够访问企业内部或特定的信息资源。

主要功能点

集成 Fess 搜索引擎: 无缝对接 Fess 搜索引擎，利用其强大的全文检索能力。
提供搜索工具: 向 MCP 客户端提供 'get_fess_search_results' 工具，允许 LLM 发起搜索请求。
访问非公开信息: 使 LLM 能够访问 Fess 索引的内部或非公开 Web 信息，例如企业文档、内部网站等。

安装步骤

Fess 服务器安装: 首先，您需要安装并运行 Fess 搜索引擎服务器。请参考 Fess 官方文档获取详细的安装和配置指南。

Fess MCP Server 安装: Fess MCP Server 可以通过 Docker 或直接使用 Python 运行。

使用 Docker: 执行 'docker-compose up -d' 命令即可启动服务器。

不使用 Docker: 确保已安装 Python 环境，然后按照以下步骤操作：

# 安装 uv (推荐的 Python 包管理器，可选)
irm https://astral.sh/uv/install.ps1 | iex
# 激活虚拟环境 (如果使用)
.\.venv\Scripts\activate.bat
# 安装依赖
uv pip install -e .
# 启动 MCP 服务器
uv run .\fess_mcp_server.py

服务器配置

Fess 服务器连接配置: 通过设置 'FESS_API_BASE' 环境变量来配置 Fess API 的 URL。如果您使用 Docker 运行，请修改 'docker-compose.yaml' 文件。默认值为 'http://host.docker.internal:8080/api/v1'。

MCP 客户端配置 (以 Claude for Desktop 为例)

要将 Claude for Desktop 连接到运行在 'localhost:8000' 的 Fess MCP Server，请将以下配置添加到 'claude_desktop_config.json' 文件中：

{
  "mcpServers": {
    "fess-search-sse": {
        "command": "npx",
        "args": [
          "-y",
          "mcp-remote",
          "http://localhost:8000/sse"
        ]
      }
  }
}

配置说明:
- '"fess-search-sse"': 服务器名称，您可以自定义。
- '"command": "npx"' 和 '"args": [...]': 用于启动 'mcp-remote' 客户端连接到 MCP 服务器的命令和参数。
- '"http://localhost:8000/sse"': Fess MCP Server 的 SSE 端点 URL。如果您的服务器运行在不同的主机或端口，请调整 'localhost:8000'。

基本使用方法

完成服务器和客户端配置后，您的 LLM 客户端（例如 Claude）即可使用注册的 'get_fess_search_results' 工具来搜索 Fess 并将结果整合到其回复中。您可以在 LLM 客户端中通过工具描述（代码注释中提供）了解如何使用该工具。

关键词