项目简介
这是一个Visual Studio Code扩展,它实现了Model Context Protocol (MCP) 服务器。其主要目标是将VS Code的工作区文件系统、编辑功能、代码诊断和符号查找等能力,以标准化的方式提供给支持MCP协议的LLM客户端(如AI助手)。
主要功能点
该扩展作为MCP服务器,为AI客户端提供了以下核心能力:
- 文件与目录操作: 允许AI客户端列出VS Code工作区中的文件和目录,并读取文件内容(支持指定编码和最大字符数)。
- 代码编辑: 支持通过编程方式创建新文件,以及基于行号和原代码验证来修改现有文件的内容。
- 代码诊断: 能够获取当前工作区或指定文件中的错误和警告信息。
- 符号查找: 允许AI客户端搜索代码库中的定义(如函数、类、变量等),帮助理解项目结构和查找特定代码元素。
- Shell命令执行: 可以在VS Code的集成终端中执行Shell命令,实现更灵活的自动化任务。
- 服务器管理: 通过VS Code状态栏项方便地启用或禁用MCP服务器。
安装步骤
- 通过VS Code扩展市场: 在VS Code中打开扩展视图 (Ctrl+Shift+X 或 Cmd+Shift+X),搜索 "VS Code MCP Server",然后点击安装。
- 从源代码安装: 克隆项目的GitHub仓库,在项目目录下运行 'npm install' 安装依赖,然后运行 'npm run compile' 编译TypeScript代码。编译完成后,你可以在VS Code的扩展视图中选择“从VSIX安装...”来安装打包好的扩展,或直接在开发模式下运行。
服务器配置(供MCP客户端使用)
MCP服务器一旦在VS Code中启动,会监听本地的一个端口(默认是3000),并通过HTTP或SSE协议提供服务。你的MCP客户端(例如,某些支持MCP的AI桌面应用)需要配置连接到这个服务器。
配置信息通常在一个JSON格式的客户端配置文件中。你需要告知客户端以下关键信息以便它能连接并使用VS Code MCP服务器:
- 服务器名称 (Server Name):客户端用来识别和引用这个服务器的名称,例如 '"vscode-mcp-server"'。
- 连接方式 (Command and Arguments):客户端需要执行的命令及其参数,以便启动一个连接到VS Code扩展服务器的进程。通常会使用一个适配器工具来建立连接。例如,如果使用官方提供的 'mcp-remote' 工具,配置可能涉及指定 'npx' 命令和 'mcp-remote' 的参数,其中一个参数就是服务器的地址,比如 'http://localhost:3000/mcp'。请参考你的MCP客户端文档以获取精确的配置格式。
重要提示: 默认情况下,服务器只绑定到 'localhost' (127.0.0.1),以增强安全性,避免在不经意间将你的VS Code环境暴露到网络中。
基本使用方法
- 在VS Code中打开你希望AI可以访问和操作的项目文件夹。
- 找到VS Code窗口底部的状态栏。你会看到一个标有 "$(server) MCP Server: Off" 的项目。
- 点击这个状态栏项。服务器将会启动,状态栏文本会更新显示服务器正在监听的端口,例如 "$(server) MCP Server: 3000"。
- 确保你的MCP客户端已正确配置,指向 'http://localhost:[端口号]/mcp' 地址。
- 现在,你的MCP客户端应该能够发现并使用此服务器暴露的各种工具,从而在你的VS Code工作区中执行任务(如读写文件、运行命令等)。
- 若要停止服务器,再次点击状态栏项即可。
信息
分类
开发者工具