Ripperdoc MCP 服务器

使用说明

  • 项目简介
    • Ripperdoc 本身是一个面向开发者的 AI 编码助手,其设计包含对 MCP 的服务器端实现能力,能够以标准化的 JSON-RPC 方式向 LLM 客户端提供上下文信息和功能,包括资源、工具与提示模板等。
    • 服务器端职责包括会话管理、能力声明、资源与工具的托管,以及对 prompts 的定义与渲染,确保 LLM 客户端可以以一致的方式获取所需的上下文和能力。
  • 主要功能点
    • 资源管理与数据访问:集中管理可供 LLM 客户端查询和使用的资源集。
    • 工具注册与执行:注册可调用的外部工具,LLM 客户端可以通过标准接口请求执行工具。
    • Prompt 模板渲染:提供可自定义的 Prompt 模板,支持不同的交互模式。
    • 会话与能力声明:对话会话的上下文、能力、权限等进行声明与管理。
    • 多传输协议支持:支持 Stdio、SSE、WebSocket 等传输通道,方便在不同场景下接入 MCP 客户端。
    • 安全与扩展性:内置权限控制、审计与扩展点,便于接入自定义的技能、钩子、工具与资源。
  • 安装步骤
    • 使用快速安装:pip install git+https://github.com/quantmew/ripperdoc.git
    • 或从源码安装(开发模式):git clone https://github.com/quantmew/ripperdoc.git;cd ripperdoc;pip install -e .
  • 服务器配置(MCP 客户端需要的启动信息)
    • 服务器名称(server name):ripperdoc-mcp-stdio,更便于标识与管理。
    • 启动命令(command):python
    • 启动参数(args):-m ripperdoc.protocol.stdio
    • 配置用途:该配置用于 MCP 客户端通过标准输入输出(Stdio)与 MCP 服务器建立 JSON-RPC 通道,完成资源、工具与提示模板等上下文服务的请求与响应。
    • 配置格式示例(JSON 说明用,非代码块展示,便于理解):
      • server_name: "ripperdoc-mcp-stdio"
      • command: "python"
      • args: ["-m", "ripperdoc.protocol.stdio"]
    • 客户端与服务器的交互要点
      • 客户端通过 JSON-RPC 发送对话上下文、资源读取、工具调用与 Prompt 获取等请求。
      • 服务器返回标准的 JSON-RPC 响应,或在需要时发送通知/事件以更新上下文。
  • 基本使用方法
    • 启动服务器:按以上启动信息在支持的环境中运行 MCP 服务器进程。
    • 客户端连接:使用 MCP 客户端连接到服务器提供的 JSON-RPC 通道,发起 Initialize/Capabilities 等标准请求。
    • 调用方式:通过标准请求读取资源、调用工具、获取 Prompt、管理会话等;服务器负责会话生命周期、能力声明以及工具和资源的协作执行。
    • 使用场景:融合 LLM 的上下文信息、工具执行、资源访问与自定义 Prompt 流程,构建可扩展的对话式应用后端。

服务器信息