使用说明

项目简介

VSCode Context MCP 是一个 Model Context Protocol (MCP) 服务器,旨在弥合 AI 助手和 VSCode 编辑器之间的鸿沟。它允许 AI 模型访问 VSCode 的上下文信息,并执行文件系统操作和 shell 命令,从而为软件开发任务提供更智能、更贴合上下文的帮助。

主要功能点

  • VSCode 上下文访问:获取当前项目路径、活动文件内容、打开的编辑器标签页、诊断问题(警告/错误)、终端输出以及工作区附加文件等VSCode环境信息。
  • 文件系统操作:支持读取、写入、编辑文件,创建目录,列出目录内容,生成目录树,搜索文件,获取文件元数据,移动/重命名文件等文件系统操作。
  • 命令执行:允许在受控环境中执行 shell 命令并捕获输出。
  • 安全性:具备基础的路径验证机制,防止访问受限目录(但仍需注意安全风险)。

安装步骤

  1. 克隆仓库

    git clone https://github.com/vilasone455/vscode-context-mcp.git
    cd vscode-context-mcp
  2. 安装依赖并构建

    npm install
    npm run build

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)集成,您需要配置客户端以启动此服务器。在客户端的配置文件(例如 'claude_desktop_config.json')中,添加 'mcpServers' 配置项。以下是一个配置示例,请根据您的实际项目路径进行修改

{
  "mcpServers": {
    "vscode-context-mcp": {  // 服务器名称,可以自定义
      "command": "node",     // 启动服务器的命令,这里使用 node
      "args": [              // 命令参数
        "/path/to/vscode-context-mcp/dist/index.js" //  指向构建后的服务器入口文件 index.js 的路径,请替换为您的实际路径
      ]
    }
  }
}

配置参数说明:

  • 'server name': 服务器的名称,用于在客户端中标识和引用。可以自定义,例如 "vscode-context-mcp"。
  • 'command': 启动服务器进程的命令。由于该服务器是 Node.js 应用,这里设置为 '"node"'。
  • 'args': 传递给启动命令的参数列表。
    • 数组中的第一个元素应为服务器入口文件 'index.js' 的绝对路径。请务必根据您克隆仓库后的实际路径进行修改。

注意:

  • 请将 '/path/to/vscode-context-mcp' 替换为您本地 'vscode-context-mcp' 仓库的实际路径。
  • 确保您的 MCP 客户端能够正确读取并应用此配置文件。

基本使用方法

  1. 启动 MCP 服务器:按照上述服务器配置,由 MCP 客户端在需要时自动启动。
  2. 在 MCP 客户端中,当需要 VSCode 上下文或文件系统操作时,AI 助手可以通过 MCP 协议调用此服务器提供的工具。
  3. 服务器接收到客户端请求后,会执行相应的操作(例如,读取文件内容、获取 VSCode 当前活动文件等),并将结果以 JSON-RPC 响应的形式返回给客户端。
  4. AI 助手根据返回的上下文信息或工具执行结果,更好地理解用户意图,并提供更精准的帮助。

例如,AI助手可能会调用以下工具:

  • 'get_vscode_context': 获取完整的 VSCode 环境上下文信息。
  • 'read_file': 读取指定路径的文件内容。
  • 'run_command': 在指定工作目录下执行 shell 命令。

安全性提示: 请务必仔细审查 AI 助手请求执行的命令和文件操作,尤其是在使用 'run_command' 和文件写入等工具时,防止潜在的安全风险。仓库的 'README.md' 中也强调了安全注意事项。

信息

分类

开发者工具