vscode-mcp-server

VS Code MCP Server

演示视频

安装

1. 从 Marketplace 安装扩展，或克隆此仓库并运行 npm install 和 npm run compile 来构建它。

Claude Desktop 配置

功能

• 列出文件和目录：在您的 VS Code 工作区中

• 读取文件内容：支持编码和大小限制

• 搜索符号：在整个工作区中

• 获取符号定义：通过行号和符号名称获取悬停信息

• 创建新文件：使用 VS Code 的 WorkspaceEdit API

• 替换行：在文件中

• 检查诊断信息：在工作区中查找错误和警告

• 执行 shell 命令：在集成终端中执行，支持 shell 集成

• 切换服务器：通过状态栏项开启或关闭

工作原理

1. 在可配置的端口上本地运行（启用时）

2. 通过 HTTP 处理 MCP 协议请求

3. 将 VS Code 的功能暴露为 MCP 工具

4. 提供一个状态栏指示器，显示服务器状态，可点击以切换服务器开关

支持的 MCP 工具

文件工具

• list_files_code：列出工作区中的文件和目录
• 参数：
• path：要列出文件的路径
• recursive（可选）：是否递归列出文件

• read_file_code：读取文件内容
• 参数：
• path：要读取的文件路径
• encoding（可选）：文件编码（默认：utf-8）
• maxCharacters（可选）：最大字符数（默认：100,000）

编辑工具

• create_file_code：使用 VS Code 的 WorkspaceEdit API 创建新文件
• 参数：
• path：要创建的文件路径
• content：要写入文件的内容
• overwrite（可选）：如果文件存在是否覆盖（默认：false）
• ignoreIfExists（可选）：如果文件存在是否忽略（默认：false）

• replace_lines_code：替换文件中的特定行
• 参数：
• path：要修改的文件路径
• startLine：起始行号（从 0 开始，包含）
• endLine：结束行号（从 0 开始，包含）
• content：用于替换行的新内容
• originalCode：用于验证的原始代码

诊断工具

• get_diagnostics_code：检查工作区中的警告和错误
• 参数：
• path（可选）：要检查的文件路径（如果未提供，则检查整个工作区）
• severities（可选）：要包含的严重级别数组（0=错误，1=警告，2=信息，3=提示）。默认：[0, 1]
• format（可选）：输出格式（'text' 或 'json'）。默认：'text'
• includeSource（可选）：是否包含诊断源。默认：true
此工具特别适用于：
• 提交更改前的代码质量检查
• 验证修复是否解决了所有报告的问题
• 识别特定文件或整个工作区中的问题

符号工具

• search_symbols_code：在整个工作区中搜索符号
• 参数：
• query：符号名称的搜索查询
• maxResults（可选）：要返回的最大结果数（默认：10）
此工具适用于：
• 查找代码库中符号（函数、类、变量等）的定义
• 探索项目结构和组织
• 按名称定位特定元素

• get_symbol_definition_code：获取文件中符号的定义信息
• 参数：
• path：包含符号的文件路径
• line：符号的行号（从 0 开始）
• symbol：在指定行上查找的符号名称
此工具提供：
• 符号的类型信息、文档和来源详情
• 显示符号所在行的代码上下文
• 符号范围信息
它特别适用于：
• 在不导航的情况下理解符号的含义
• 检查函数签名、类型定义或文档
• 快速参考 API 或库函数

Shell 工具

• execute_shell_command_code：在 VS Code 集成终端中执行 shell 命令，支持 shell 集成
• 参数：
• command：要执行的 shell 命令
• cwd（可选）：命令的可选工作目录（默认：'.'）
此工具适用于：
• 运行 CLI 命令和构建操作
• 执行 git 命令
• 执行任何需要终端访问的 shell 操作
• 获取命令输出以进行分析和进一步处理

注意事项/TODO

扩展设置

• vscode-mcp-server.port：MCP 服务器的端口号（默认：3000）

与 MCP 客户端一起使用

贡献

许可证