使用说明

项目简介

VSCode MCP Server 是一个 MCP (Model Context Protocol) 服务器的实现,旨在使 AI 智能助手(如 Goose 或 Claude)能够通过标准化的 MCP 协议与 VS Code 编辑器进行交互。它作为 AI 智能体与 VS Code 之间的中间层,允许 AI 智能体调用 VS Code 的功能,例如文件操作、项目管理等,从而实现更智能化的代码编辑和开发流程。

主要功能点

  • 工具 (Tools) 注册与执行: 提供了一系列预定义的工具,允许 AI 智能体通过调用这些工具来操作 VS Code,例如:
    • 'create_diff': 创建并展示文件修改的差异,需要用户批准后应用更改。
    • 'open_file': 在 VS Code 编辑器中打开文件。
    • 'open_project': 在 VS Code 中打开项目文件夹。
    • 'check_extension_status': 检查 VS Code MCP 扩展是否已安装并正常响应。
    • 'get_extension_port': 获取 VS Code MCP 扩展的端口号。
    • 'list_available_projects': 列出可用的项目列表。
  • 资源 (Resources) 管理: 虽然文档中没有明确提及资源管理,但通过文件和项目操作工具可以看出,服务器间接管理着 VS Code 中的文件系统和项目资源。
  • Prompt 模板 (Prompts): 仓库信息中没有直接提及 Prompt 模板,但 MCP 服务器的架构设计本身支持未来扩展 Prompt 模板功能,以支持更灵活的 LLM 交互模式。
  • JSON-RPC 通信: MCP 服务器通过 JSON-RPC 协议与 MCP 客户端(如 AI 智能体)进行通信,接收请求并返回响应。
  • 会话管理: 服务器端负责处理来自客户端的会话,并维护连接状态。
  • 能力声明: 服务器声明了自身提供的工具能力,供 MCP 客户端发现和使用。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统中已安装 Node.js 和 npm (Node 包管理器)。
  2. 安装 VSCode MCP Server: 打开终端,运行以下命令全局安装 'vscode-mcp-server':
    npx vscode-mcp-server install
    这个命令会自动下载并安装 VSCode MCP Server 及其依赖。
  3. 安装 VSCode MCP 扩展: 在 VS Code 扩展商店搜索 "MCP Extension" (发布者为 'gertig') 并安装。或者通过 MCP Extension 链接进行安装。

服务器配置

要使 MCP 客户端(例如 Goose Desktop 或 Claude Desktop)能够连接到 VSCode MCP Server,需要在客户端中配置服务器信息。以下是针对 Goose Desktop 和 Claude Desktop 的配置示例:

Goose Desktop 配置 (JSON 格式,在 Goose 设置中配置)

{
  "ID": "vscode-mcp",        // 服务器 ID,自定义,用于在 Goose 中标识该服务器
  "Name": "VS Code",         // 服务器名称,在 Goose 界面中显示
  "Description": "Allows interaction with VS Code through the Model Context Protocol", // 服务器描述,可选
  "Command": "npx vscode-mcp-server"  // 服务器启动命令,指向 vscode-mcp-server 的可执行文件
}

Claude Desktop 配置 (JSON 格式,在 'claude_desktop_config.json' 文件中配置)

通常 Claude Desktop 的配置文件路径为 '~/Library/Application Support/Claude/claude_desktop_config.json' (macOS) 或 '~/AppData/Roaming/Claude/claude_desktop_config.json' (Windows)。

{
  "mcpServers": {
    "vscode-mcp-server": {  // 服务器名称,自定义,用于在 Claude 中标识该服务器
      "command": "npx",     // 启动命令
      "args": ["vscode-mcp-server"], // 命令参数
      "env": {}             // 环境变量,通常为空
    }
  }
}

基本使用方法

  1. 启动 VSCode MCP Server: 安装成功后,VSCode MCP Server 通常会在后台运行。如果未运行,可以在终端中运行 'npx vscode-mcp-server' 命令手动启动。
  2. 启动 VS Code 并打开项目: 确保 VS Code 已经启动,并且打开了你希望 AI 智能体操作的项目文件夹。
  3. 配置并连接 MCP 客户端: 在你的 MCP 客户端(如 Goose 或 Claude)中,根据上述 "服务器配置" 部分的说明,配置 VSCode MCP Server 的连接信息。
  4. 使用 AI 智能体: 配置完成后,AI 智能体应该能够通过 VSCode MCP Server 提供的工具与 VS Code 进行交互。你可以尝试使用 AI 智能体的指令,例如让它打开文件、修改代码、查看项目结构等,来测试连接和功能是否正常。

注意: VSCode MCP Server 依赖于 VS Code MCP 扩展才能与 VS Code 编辑器进行深度集成。请务必安装 VS Code MCP 扩展。

信息

分类

开发者工具