Fess MCP Server

🚀 Fess MCP 服務器

Fess MCP 服務器是一款與 Fess 搜索引擎集成的中間件服務器。通過在 MCP 客戶端（如 Desktop Claude）的設置中註冊該服務器，即可允許代理藉助 Fess 獲取信息。Fess 是一個開源的全文檢索服務器，基於 Apache 許可證提供，同時也提供商業支持。如需瞭解更多詳細信息，請訪問官方網站。 https://fess.codelibs.org/ja/

🚀 快速開始

Fess MCP 服務器可幫助您在 MCP 客戶端中利用 Fess 搜索引擎獲取信息。您需要先安裝 Fess 服務器和 Fess MCP 服務器，再進行相應的配置，最後通過測試確保其正常運行。

📦 安裝指南

Fess 安裝

有關 Fess 服務器本身的安裝步驟，請參閱官方 Fess 文檔。 https://qiita.com/g_fukurowl/items/a00dbbad737d3e775108

以下文章也可能有幫助： https://qiita.com/g_fukurowl/items/a00dbbad737d3e775108

Fess MCP Server 安裝

使用 Docker

使用以下命令啟動服務器：

docker-compose up -d

不使用 Docker

這裡展示了使用 uv 的安裝步驟。uv 是一個快速的 Python 包管理器。雖然不是必需的，但建議使用它。

# 安裝 uv
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 MCP Server 訪問的 Fess 服務器 URL 設置為環境變量 Fess_API_BASE。請在啟動 Fess MCP Server 前根據您的環境修改此變量。如果是 Docker 容器運行，請編輯 docker-compose.yaml 並更改相關設置。

Desktop Claude 連接設置

Fess MCP Server 默認在 8000 端口上運行。如果 Fess MCP Server 在 localhost 的 8000 端口上運行，則編輯 claude_desktop_config.json 如下：

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

💻 使用示例

基礎用法

按照上述安裝和配置步驟完成後，您就可以在 MCP 客戶端（如 Desktop Claude）中使用 Fess MCP Server 來獲取 Fess 搜索引擎的信息了。

📚 詳細文檔

測試

不使用 Docker

這裡展示了使用 uv 的測試步驟。

# 安裝開發依賴項：
uv pip install -e ".[test]"

# 運行單元測試：
uv run pytest -v tests/unit/ -s

# 運行集成測試（需要與 Fess 服務器通信）：
uv run pytest -v tests/integration/ -s

# 生成覆蓋率報告：
uv run pytest --cov=fess_mcp_server --cov-report=html

在 Docker 容器中運行測試

# 構建測試 Docker 鏡像：
docker build -t fess-mcp-server-test -f Dockerfile.test .

# 運行單元測試：
docker run --rm fess-mcp-server-test pytest -v tests/unit/ -s

# 運行集成測試（需要與 Fess 服務器通信）：
docker run --rm --network host fess-mcp-server-test pytest -v tests/integration/ -s

# 生成覆蓋率報告：
docker run --rm -v ${PWD}/coverage:/app/coverage fess-mcp-server-test pytest --cov=fess_mcp_server --cov-report=html

測試執行選項

• -v：顯示詳細輸出
• -s：顯示標準輸出
• --cov：生成覆蓋率報告
• --cov-report=html：生成 HTML 格式覆蓋率報告

📄 許可證

本項目採用 MIT License。