keephive

使用说明

  • 项目简介
    • keephive 是一个集成式的后端服务框架,核心围绕 MCP(Model Context Protocol)实现,向 MCP 客户端提供统一的上下文服务能力。它通过一个服务器组件暴露资源、工具和提示模板,并通过 JSON-RPC 与客户端交互,支持多种传输方式(如标准输入/输出、Server-Sent Events、WebSocket)。
  • 主要功能点
    • 资源管理(Resources):提供可供 LLM 客户端访问的数据资源和知识存储。
    • 工具注册与执行(Tools):注册可远程调用的外部工具,LLM 客户端可通过 MCP 服务器调用这些工具。
    • Prompt 模板(Prompts):定义、渲染与管理可定制的提示模板,帮助引导与控制对话。
    • JSON-RPC 通信:服务器端接收客户端请求(读取资源、调用工具、获取 Prompts 等),返回标准的 JSON-RPC 响应或发送通知。
    • 会话管理与能力声明:包含会话上下文、能力展示,以及对多传输协议的支持。
  • 安装步骤
    • 直接从源码运行:将仓库克隆到本地后进入仓库根目录,按项目依赖安装即可运行 MCP 服务器(通常包含 py 依赖与运行脚本)。
    • 运行 MCP 服务器(示例场景,不给出具体代码实现细节,只描述用途):
      • 启动命令:python -m keephive mcp-serve
      • 支持的端口/端点取决于实现,通常通过 TCP/标准输入输出或通过 SSE/WebSocket 进行传输。
  • 服务器配置(MCP 客户端需要的配置信息,供对接时在客户端 JSON 配置中使用;以下为描述性注释,不包含具体代码)
    • server name: keephive
    • command: mcp-serve
    • args: [](若需要可添加如 --host、--port、--transport 等参数,请结合实际实现)
    • 注释说明:
      • 客户端在 MCP 配置中通常只需要知道服务器的名称、启动命令和参数,以便通过 JSON-RPC 向服务器发起请求。
      • 服务器端的实现会处理诸如读取资源、执行工具、获取提示模板等 MCP 请求,并返回标准的 JSON-RPC 响应或通知。
  • 基本使用方法
    • 使用 MCP 客户端对 keephive 的资源、工具和 Prompts 发起请求,例如:
      • 读取某资源信息
      • 调用已注册工具以执行外部行为
      • 获取并渲染提示模板用于 LLM 会话
    • 服务器应维持会话上下文、暴露能力声明,并根据请求返回合适的 JSON-RPC 响应或通知给客户端。
    • 同时,服务器应通过配置的传输协议向客户端推送实时状态/事件(若客户端支持 SSE/WebSocket)。

服务器信息