使用说明内容（Markdown格式）

• 项目简介

  • 这是一个为 Fess（企业搜索服务器）实现的 MCP（Model Context Protocol）服务器端插件。它通过 JSON-RPC 2.0 与客户端进行通信，提供对资源、工具和提示的托管、查询和执行能力。插件内置的 API 设计用于在后端向 LLM 客户端提供上下文信息、数据访问和功能调用的能力。

• 主要功能点

  • JSON-RPC 2.0 合规的 MCP API：按统一协议处理请求与响应
  • MCP 协议支持：实现特定版本的协议能力与上下文管理
  • Tools/Resources/Prompts 三大核心能力：
    • Tools：列出、调用可用工具（如搜索、获取索引状态等）
    • Resources：列出与读取可用资源（如索引统计信息等）
    • Prompts：列出、获取并渲染提示模板
  • Prompts 渲染：根据提供的参数生成对话内容（Content 段落以文本形式输出）
  • 文档内容渲染：将检索结果等转为 MCP 支持的文本内容格式
  • 错误处理：严格遵循 JSON-RPC 2.0 的错误码约定
  • 嵌入式实现：作为 Fess 的插件运行，启动与依赖通过 Fess 环境管理
  • 服务器端行为包括会话管理、能力声明等

• 安装步骤

  • 1. 编译插件：使用 Maven 构建插件包
  • 2. 将插件 JAR 放置到 Fess 的插件目录（与其他插件同目录）
  • 3. 重新启动 Fess 服务，使插件生效
  • 4. 通过 MCP 端点进行交互：向 http://<fess-server>:<port>/mcp 发送 JSON-RPC 2.0 请求

• 服务器配置（MCP 客户端需要的连接信息说明，实际部署为 Fess 中的插件运行环境）

  • 服务器名称（serverName）：fess-mcp-server
  • 启动方式（command）：在 Fess 启动时加载 fess-webapp-mcp 插件即可，无需单独启动命令
  • 启动参数（args）：无单独参数，若有需注入，请以在 Fess 启动参数中的插件加载方式为准
  • 访问端点（endpoint）：http(s)://<host>:<port>/mcp
  • 备注：MCP 客户端与 MCP 服务器之间的实际通信基于该端点，客户端不需要额外启动服务器的步骤，仅需要配置连接端点即可

• 基本使用方法

  • 1. 初始化会话：向 /mcp 发送 initialize 方法，获取协议版本、能力与服务器信息
  • 2. 列出能力项：调用 tools/list、resources/list、prompts/list 了解可用的工具、资源与提示
  • 3. 调用工具：使用 tools/call 传入名称与参数，执行相应的操作（如 search、get_index_stats）
  • 4. 读取资源：通过 resources/read 获取资源内容
  • 5. 获取并使用提示：调用 prompts/get 获取具体的提示文本，并通过 prompts/list 了解可用提示
  • 6. 错误处理：若请求不合法或方法未实现，将返回符合 JSON-RPC 2.0 的 error 对象

• 说明

  • 本 MCP 服务器实现为 Fess 的一个插件，与传统的独立服务器不同，运行依赖于 Fess 容器/进程。在客户端侧，需将目标服务器的启动方式设为访问 Fess 实例的 /mcp 端点即可，插件自身提供完整的 MCP 接口和业务逻辑。