使用说明

一、项目简介

Rulekit MCP 是一个面向 LLM 的后端服务，核心职责是以标准化的方式向客户端提供可访问的资源（Resources）、可注册并执行的工具（Tools）以及可渲染的提示模板（Prompts），并通过 MCP 协议进行通信。服务器支持多种传输方式（如基于 HTTP 的请求/响应、SSE 流式传输等），并提供会话管理、能力声明以及规则的动态加载与合并，帮助你把规则、资源和工具组织成可扩展的上下文服务。

二、主要功能点

• 资源管理（Resources）
  • 规则集、资产等资源的托管与读取，按作用域（项目、组、技术、语言）以统一 URI 访问。
• 工具注册与执行（Tools）
  • 提供诸如读取规则、列出 Keys、搜索规则、获取资产等工具，LLM 可以通过工具与服务器交互获取数据或执行操作。
• 提示模板（Prompts）
  • 提供系统级别的提示模板，用于引导 LLM 在开发场景中正确使用服务器提供的上下文。
• 动态加载与上下文合并
  • 按需加载规则，并将不同作用域的规则合并为上下文，保证上下文规模在可控范围内。
• 多传输协议支持
  • 设计支持多种传输通道（HTTP POST、SSE、WebSocket 等），以适配不同客户端实现。
• 会话与状态管理
  • 通过会话标识管理不同的 MCP 会话与传输管道，确保上下文的一致性与隔离性。

三、安装步骤

• 环境要求
  • 已安装 Docker 与 Docker Compose，或具备与仓库 README 中一致的部署方式。
• 运行服务器
  • 根据项目提供的文档，使用容器化方式启动服务，可执行 Docker Compose 指令来启动。
  • 启动后服务器监听指定端口（默认 3627），接受来自 MCP 客户端的请求。

四、服务器配置（JSON 配置，供 MCP 客户端使用）

下列信息用于给 MCP 客户端指明如何启动并连接到 MCP 服务器，以及服务器的识别信息（无需在客户端执行，主要作为连接配置示例）：

• server_name: rulekit-mcp
• command: docker
• args: ["compose", "up", "-d"]

注释说明：

• server_name 表示 MCP 服务器的唯一标识名称，便于在客户端管理会话与对照。
• command 与 args 指定启动服务器时所用的命令及参数，客户端据此可在需要时执行相应的启动流程（如在容器环境中以 Docker Compose 启动服务）。实际部署环境中，客户端通常不直接执行服务器作业，但该配置提供了明确的启动方式以便快速部署。

五、基本使用方法

• 客户端与服务器交互
  • 通过 MCP 的 JSON-RPC 请求向 /mcp 端点发送请求，或通过 SSE 流建立持续连接，以获取实时的上下文与结果。
  • 客户端可以读取资源、调用工具、获取并渲染 Prompts，用于与 LLM 的交互。
• 常用操作
  • 获取某个范围的规则、资源列表、资产内容等。
  • 调用工具执行数据获取、规则检索、规则合并等操作。
  • 使用 prompts 获取用于系统对话的上下文内容。
• 部署与运维
  • 如需停止/重启服务，请使用 Docker Compose 的相关命令，确保容器资源正常清理。
  • 关注日志输出以排查连接、请求处理或资源加载等问题。

注意：MCP 客户端需要的仅是服务器的登录/连接信息、可用的资源与工具的描述，以及如何启动服务器的指引。以上信息与仓库实现保持一致，可帮助你在本地或云环境中快速部署并与客户端集成。