使用说明(Markdown 格式)

  • 项目简介 NTS_MCP_FS 是一个基于 MCP 的后端服务器实现,专为向大语言模型(LLM)客户端提供结构化的上下文信息和功能而设计。核心职责包括托管和管理资源、注册与执行工具、以及定义和渲染 Prompt 模板,所有通信均通过 JSON-RPC 风格的请求与响应完成。服务器支持会话管理、能力声明,并具备在 STDIO、SSE、WebSocket 等传输通道上工作的能力,确保对多客户端并发请求的可扩展性。

  • 主要功能点

    • MCP 协议处理:接收 JSON-RPC 请求,解析方法(如 initialize、tools/list、tools/call、ping 等),并返回标准的 JSON-RPC 响应。
    • 资源与工具管理:内置工具集合用于资源读写、文件管理、导航、代码重构、批量执行等;提供工具列表与逐工具调用能力。
    • 会话与安全:支持会话初始化、会话隔离、LAT(Line Access Token)等访问控制机制,确保对文件操作的原子性与回滚能力。
    • Prompts 与渲染:具备 Prompts 的定义与渲染能力,便于定义 LLM 的交互模板。
    • 多传输协议支持:设计具备在 Stdio、SSE、WebSocket 等通道中工作的能力,方便不同客户端接入。
    • 日志与调试:可通过 MCP_DEBUG、MCP_LOG_FILE 环境变量开启调试输出与持久化日志。
  • 安装步骤

    1. 构建整合包
      • 使用 Gradle 构建 shadowJar,生成可执行的整合 JAR 包。
      • 命令示例(在项目根目录执行):gradlew shadowJar
    2. 启动服务器
      • 直接运行打包后的 JAR,服务器将通过标准输入接收 MCP 请求并通过标准输出返回响应。
      • 常见启动方式:java -jar app/build/libs/app-all.jar
    3. 客户端连接准备(见下方服务器配置示例)
      • MCP 客户端需要配置启动命令与参数,以便通过进程的 STDIN/STDOUT 与服务器建立通信。
  • 服务器配置(面向 MCP 客户端的连接配置说明) 服务器名称:NTS-FileSystem-MCP 启动指令示例(文本描述,实际请按需替换路径):

    • serverName: NTS-FileSystem-MCP
    • command: java
    • args: ["-jar", "/absolute/path/to/app-all.jar"]

    说明:上述配置用于 MCP 客户端在启动时按照该命令启动 MCP 服务器进程,进程通过标准输入读取 MCP 请求,标准输出返回 MCP 响应。实际路径请替换为本地打包后的 app-all.jar 的绝对路径。客户端不需要在此处看到服务器实现的内部细节,只需要能够正确启动并与服务器进行 JSON-RPC 通信。

  • 基本使用方法

    • 初始化会话:客户端发送 initialize 请求,服务器返回协议版本、服务器信息以及能力声明,建立后续会话。
    • 调用工具与资源:通过 tools/list、tools/call、或具体的工具操作请求,服务器返回相应的结果与可选的 TOKEN(LAT)用于编辑/操作。
    • 交易与回滚:在需要的一系列操作中,若某一步失败,整体交易可回滚,以维持数据一致性。
    • 使用环境与调试:如遇问题,可通过 MCP_DEBUG、MCP_LOG_FILE 指定的方式查看详细日志。
  • 注意事项

    • MCP 客户端需要了解服务器的启动方式与连接方式,确保能够通过 JSON-RPC 与服务器进行交互。
    • 服务器实现具备多工具、会话、以及批量执行能力,适合复杂的自动化工作流与 LLM 辅助的代码上下文服务。

信息

分类

AI与计算