使用说明(Markdown 格式)

  • 项目简介

    • virtme-ng 自带的 MCP 服务器模块提供了一组可通过 MCP 客户端调用的工具,用于管理内核的构建、配置、补丁应用以及自测相关流程。该服务器面向 AI 助手或自动化系统,通过标准化的 JSON-RPC 请求/响应与客户端通信,提升内核开发与测试的自动化能力。
  • 主要功能点

    • MCP 服务端核心能力:实现 MCP 协议的服务器端,接收来自 AI 客户端的工具调用请求,返回执行结果或执行通知。
    • 工具集合(Tools):包括构建内核、配置内核、运行自测、生成自测脚本、获取内核信息、应用补丁等工具,每个工具返回一个可执行的命令,供客户端在 Shell 环境中执行。
    • 安全与会话:提供会话管理与可扩展的传输支持(标准 MCP 依赖,理论上可通过标准输入/输出实现通信)。
    • 兼容性与扩展性:与 virtme-ng 的其他组件耦合,支持通过 MCP 传输触发内核构建、配置和测试工作流,便于与大语言模型结合进行端到端的 kernel development 流程。
  • 安装步骤

    • 安装依赖
      • 需要 Python 环境,以及可选的 MCP 库:pip install mcp
      • 若要通过仓库内可选特性启用 MCP 支持,执行:pip install virtme-ng[mcp]
    • 启动方式
      • 直接运行 MCP 服务端程序(在仓库中实现为 virtme_ng.mcp 模块的入口),或者通过 vng 命令启用 MCP 模式:
        • 启动方式 A(推荐): vng --mcp
        • 启动方式 B: vng-mcp(直接执行入口,由打包提供的可执行脚本实现)
    • 运行后端将监听 MCP 客户端的 JSON-RPC 请求,返回工具执行结果与必要的上下文信息。
    • 如果遇到依赖问题,请确保安装了 mcp 库及其依赖,例如 pip install virtme-ng[mcp]。
  • 服务器配置(MCP 客户端需要了解的连接信息,示例为 JSON 配置)

    • 说明:MCP 客户端需要的配置信息仅用于描述如何连接到本 MCP 服务器。配置包含服务器名称、启动命令及参数等。以下为符合仓库实现的准确示例信息,实际使用时请依据客户端框架直接加载该配置。
    • JSON 示例(用于 MCP 客户端注册 virtme-ng 服务端): { "mcpServers": { "virtme-ng": { "command": "vng", "args": ["--mcp"] } // 说明: // - server name: virtme-ng // - command: 启动 MCP 服务的可执行程序 // - args: 启动时传递的参数列表,示例中为 --mcp,表示启用 MCP 服务端模式 } }
    • 说明要点
      • 客户端无需实现服务器端逻辑,只需按照上述配置通过 MCP 框架连接即可。
      • 如果服务器需要额外的启动参数(如日志、认证、传输协议等),可在 args 中扩展。
  • 基本使用方法

    • 步骤 1:确保 MCP 相关依赖已安装(如 mcp 包和 virtme-ng[mcp] 扩展)。
    • 步骤 2:以 MCP 服务器模式启动 virtme-ng 的服务器端(通过 vng --mcp 或 vng-mcp)。
    • 步骤 3:在 MCP 客户端(如 Claude/Cursor 等 AI 助手)中注册服务器,使用上述配置中的 servername、command 与 args。
    • 步骤 4:通过 MCP 客户端发起工具调用,例如调用 build_kernel、configure_kernel、run_kernel_cmd 等工具,服务器返回要执行的单条命令,用户在 Shell 端执行,并将输出返回给客户端。
    • 步骤 5:根据需要组合多个工具调用,形成完整的 kernel 开发与测试工作流。
  • 备注

    • MCP 服务器的实现与集成依赖于仓库中的 mcp 模块及其依赖,实际运行前需要将相关依赖正确安装。
    • 服务器返回的工具输出通常是需要在 Shell 中执行的一条命令,目的是让客户端能够以最小化、可重复的方式完成复杂操作。

信息

分类

开发者工具