使用说明

项目简介

vscode-local-snapshots 是一款 VS Code 扩展,它不仅提供了便捷的本地快照管理功能,还内建了 MCP (Model Context Protocol) 服务器。该服务器允许支持 MCP 协议的 AI 工具(如 Cursor AI)直接与 VS Code 集成,利用扩展提供的快照功能,实现更智能化的代码编辑和版本管理。

主要功能点

  • 资源管理 (Resources): 虽然仓库描述中未明确提及资源管理,但 MCP 服务器的核心是提供上下文信息,快照本身可以被视为工作区状态的一种资源。
  • 工具注册和执行 (Tools): 内置 'takeNamedSnapshot' 工具,允许 MCP 客户端请求服务器在 VS Code 中创建命名快照。
  • Prompt 模板 (Prompts): 仓库描述中未提及 Prompt 模板功能。
  • SSE 通信: 通过 SSE (Server-Sent Events) 协议与 MCP 客户端进行实时通信。
  • 会话管理: 支持 MCP 会话管理,为每个客户端连接创建独立的会话。
  • 能力声明: 声明服务器提供的 MCP 能力,例如支持的工具列表。

安装步骤

  1. 安装 VS Code 扩展: 在 VS Code 扩展商店搜索 'vscode-local-snapshots' 并安装。

服务器配置

对于 MCP 客户端(例如 Cursor AI)的配置,您需要提供 MCP 服务器的连接信息。以下是一个配置示例,用于连接到本地运行的 vscode-local-snapshots MCP 服务器:

{
  "mcpServers": {
    "local-snapshots": {
      "transport": "sse",
      "url": "http://localhost:PORT/sse"
    }
  }
}

配置参数说明:

  • 'server name': 'local-snapshots' (服务器名称,可自定义)
  • 'transport': 'sse' (传输协议,固定为 SSE)
  • 'url': 'http://localhost:PORT/sse' (MCP 服务器 URL,PORT 需要替换为 VS Code 扩展实际启动的端口号,端口号通常为 '45679',如果被占用会自动分配其他端口。端口号信息可在 VS Code 扩展设置页面的 MCP Server 选项卡中查看)

注意: MCP 客户端无需配置启动命令 (command) 和参数 (args),因为 vscode-local-snapshots MCP 服务器作为 VS Code 扩展的一部分运行,由 VS Code 插件激活和管理。

基本使用方法

  1. 启用 MCP 服务器: 在 VS Code 设置中,搜索 'localSnapshots.enableMcpServer' 并勾选启用。
  2. 查看服务器状态: 启用后,VS Code 状态栏会显示 MCP 服务器状态和实际端口号。您也可以在扩展设置页面的 MCP Server 选项卡中查看连接 URL。
  3. 配置 MCP 客户端: 在您的 MCP 客户端(如 Cursor AI)中,按照上述 服务器配置 示例进行配置,并将 'url' 中的 'PORT' 替换为实际端口号。
  4. 使用 MCP 工具: 配置完成后,MCP 客户端即可调用 vscode-local-snapshots 提供的 MCP 工具,例如 'takeNamedSnapshot' 工具可以指示 VS Code 创建一个命名快照。

可用 MCP 工具

  • 'takeNamedSnapshot': 创建指定名称的工作区快照
    • 参数:
      • 'name': 字符串类型,快照名称 (必填)

信息

分类

开发者工具