使用说明

项目简介

VS Code MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在作为 VS Code 编辑器与 AI 智能体(如 Goose 或 Claude)之间的桥梁。它允许 AI 智能体通过标准化的 MCP 协议,调用 VS Code 的功能,实现代码编辑、文件操作、项目管理等任务。该项目包含 MCP 服务器的实现以及配套的 VS Code 扩展,共同为 AI 应用提供上下文服务。

主要功能点

  • 工具注册与执行: 提供了一系列预定义的工具,例如 'create_diff' (创建差异预览)、'open_file' (打开文件)、'open_project' (打开项目)、'check_extension_status' (检查扩展状态)、'get_extension_port' (获取扩展端口)、'list_available_projects' (列出可用项目)。这些工具允许 AI 智能体与 VS Code 进行丰富的交互。
  • 文件操作: 支持创建文件差异预览('create_diff'),并需要用户批准后才应用更改,确保操作安全可控。支持打开文件('open_file')和打开项目('open_project'),方便 AI 智能体进行代码浏览和项目管理。
  • 扩展状态监控: 提供了工具来检查 VS Code MCP 扩展的运行状态('check_extension_status')和获取端口信息('get_extension_port'),方便集成和调试。
  • 项目管理: 能够列出可用的 VS Code 项目('list_available_projects'),并支持打开指定的项目,为 AI 智能体提供项目上下文。

安装步骤

  1. 安装 VS Code MCP Server: 打开终端,运行以下命令全局安装 'vscode-mcp-server' 包:

    npx vscode-mcp-server install

    该命令会自动安装服务器,并尝试更新 Claude 和 Goose 的配置文件,以便它们能够识别和连接到 VS Code MCP Server。

  2. 安装 VS Code MCP 扩展: 在 VS Code 扩展商店搜索 "MCP Extension" 或 "gertig.mcp-extension",点击安装。或者通过链接 MCP Extension 进行安装。

服务器配置

MCP 客户端(例如 Goose 或 Claude)需要配置以下信息才能连接到 VS Code MCP Server。以下是配置示例,请根据您的 MCP 客户端进行相应配置。

Goose Desktop 配置示例:

在 Goose 的设置中,添加一个新的扩展连接,配置信息如下:

{
  "ID": "code-mcp",
  "Name": "VS Code",
  "Description": "Allows interaction with VS Code through the Model Context Protocol",
  "Command": "npx vscode-mcp-server"
}

Claude Desktop 配置示例:

在 Claude Desktop 的配置文件 ('~/Library/Application Support/Claude/claude_desktop_config.json' 或 Windows 上的相应路径) 中,添加 'mcpServers' 配置:

{
  "mcpServers": {
    "vscode-mcp-server": {
      "command": "npx",
      "args": ["vscode-mcp-server"],
      "env": {}
    }
  }
}

配置参数说明:

  • 'server name': 'vscode-mcp-server' (服务器名称,用于在客户端中标识)
  • 'command': 'npx' (启动命令,使用 npx 运行 npm 包)
  • 'args': '["vscode-mcp-server"]' (命令参数,指定要运行的 npm 包为 vscode-mcp-server)

基本使用方法

  1. 确保 VS Code MCP 扩展已在 VS Code 中安装并启用。
  2. 启动 VS Code MCP Server。如果您已经按照安装步骤全局安装了 'vscode-mcp-server',则可以在终端中直接运行 'vscode-mcp-server' 命令来启动服务器。
  3. 在您的 MCP 客户端(如 Goose 或 Claude)中,配置连接到 VS Code MCP Server。配置信息请参考 服务器配置 部分。
  4. 客户端连接成功后,AI 智能体即可通过 MCP 协议调用 VS Code MCP Server 提供的工具,与 VS Code 进行交互,例如打开文件、创建代码差异等。

信息

分类

开发者工具