Lilbee MCP 服务端

使用说明（Markdown 格式）

• 项目简介

  • 该仓库实现了一个 MCP 服务器，负责以标准化的 JSON-RPC 方式向 LLM 客户端提供：资源管理与检索、工具注册与执行，以及提示模板渲染等能力，方便在本地离线环境中为大语言模型提供可上下文化的外部数据与功能。

• 主要功能点

  • 资源与数据管理：维护本地文件索引、分块存储与检索，支持将文档与代码等按需嵌入向量化，并提供查询上下文。
  • 工具注册与执行：通过 MCP 将 Lilbee 的查询/索引能力暴露为可调用的工具，LLM 客户端可调用这些工具完成特定任务。
  • Prompts 渲染与上下文提供：实现对 Prompt 模板的渲染与上下文拼接，帮助 LLM 在回答中引用相关来源。
  • JSON-RPC 通信：服务器与客户端通过 JSON-RPC 进行请求/响应交互，覆盖读取资源、调用工具、获取提示等操作。
  • 传输协议灵活性：设计目标包含多种传输协议支持（如 stdio、SSE、WebSocket），以适配不同的部署场景。
  • 会话与能力声明：服务器端负责会话状态和能力声明，方便客户端动态识别可用能力。

• 安装步骤

  • 安装依赖：确保已安装 Python 3.11+，以及仓库所需的运行时依赖。
  • 安装包：通过 pip 安装本项目，或从源代码运行所需模块。
  • 运行服务器：在本地环境中启动 MCP 服务器，示例为通过 Python 模块运行（后续步骤给出启动方式的描述）。

• 服务器配置（JSON，供 MCP 客户端读取并连接）

  • server_name: lilbee
  • command: python
  • args: ["-m", "lilbee.mcp"]
  • transports: ["stdio"] // 如需扩展可配置 "stdio", "sse", "websocket" 等
  • description: 本 MCP 服务器名称与启动命令信息，客户端据此启动并通过 JSON-RPC 进行通信 注：以上配置仅用于客户端了解如何启动服务器进程和连接方式。实际运行时，服务器进程应按上述命令启动并监听对应的 JSON-RPC 通道。

• 基本使用方法

  • 启动服务器后，客户端通过 JSON-RPC 调用 lilbee_search、lilbee_status、lilbee_sync、lilbee_reset 等工具接口，获取查询结果、索引状态、同步进度等信息。
  • 客户端可通过工具接口执行外部功能，获得标准化的 JSON-RPC 响应与必要的上下文数据。
  • 如需多传输协议支持，可将传输层改造为 SSE/WebSocket 等，继续保持 JSON-RPC 请求/响应格式的兼容性。

• 运行与测试要点

  • 服务器实现位于 lilbee.mcp 模块，具备 lilbee_search、lilbee_status、lilbee_sync、lilbee_reset 等工具入口。
  • 通过相应的单元测试可验证核心功能的正确性与输出格式。