使用说明

项目简介

VSCode MCP Server (vsc-mcp) 是一款 VSCode 扩展,它充当 MCP 服务器,允许支持 MCP 协议的 LLM 客户端(例如 Cursor 编辑器)连接到 VSCode,并获取 VSCode 的上下文信息和执行特定操作。该服务器通过 SSE (Server-Sent Events) 协议与客户端通信,提供实时的上下文更新和工具调用能力。

主要功能点

  • 资源管理: 提供对 VSCode 编辑器资源的访问,例如当前打开的文件列表。
  • 工具注册与执行: 注册并暴露 VSCode 的功能为工具,例如:
    • 文件管理工具:获取已打开文件列表、关闭指定文件。
    • 主题管理工具:列出可用主题、获取当前主题、设置主题。
  • 基于 SSE 的通信: 使用 Server-Sent Events 协议与 MCP 客户端进行实时通信。
  • 易于安装和配置: 作为 VSCode 扩展安装,配置简单,易于集成到支持 MCP 的 LLM 应用中。

安装步骤

  1. 安装扩展: 在 VSCode 扩展商店搜索 'vsc-mcp' 并安装。
  2. 启动服务器: 扩展安装后,MCP 服务器会在 VSCode 启动时自动启动。您也可以通过 VSCode 命令面板 (Cmd+Shift+P 或 Ctrl+Shift+P) 执行 'Start MCP Server' 命令手动启动服务器。
  3. 停止服务器: 可以通过 VSCode 命令面板执行 'Stop MCP Server' 命令手动停止服务器。

服务器配置

MCP 服务器监听地址为 'http://localhost:3344/sse'。 MCP 客户端需要配置连接到此地址才能使用 vsc-mcp 服务器提供的功能。

以下是针对 Cursor 编辑器的 MCP 客户端配置示例 ( '~/.cursor/mcp.json' ):

{
  "mcpServers": {
    "vsc-mcp": {
      "url": "http://localhost:3344/sse"
    }
  }
}

基本使用方法

  1. 启动 VSCode 和 vsc-mcp 扩展
  2. 配置 MCP 客户端: 在您的 MCP 客户端(例如 Cursor)中,按照其文档配置 MCP 服务器连接,使用上述提供的服务器配置信息。
  3. 连接并使用: 客户端成功连接后,即可通过客户端界面或指令,调用 vsc-mcp 服务器提供的资源和工具,例如:
    • 请求获取当前打开的文件列表。
    • 调用工具关闭指定文件。
    • 调用工具切换 VSCode 主题。

注意: 目前 vsc-mcp 主要提供文件管理和主题管理相关的工具,更多功能可能会在未来版本中添加。 请参考项目仓库的 README 文件获取最新的工具列表和更新信息。

信息

分类

开发者工具