README
🚀 VSCode 上下文 MCP 服务
VSCode 上下文 MCP 服务是一个基于 Model Context Protocol (MCP) 的服务器,它在 AI 助手与 VSCode 环境之间搭建了桥梁,能为 AI 助手提供 VSCode 环境上下文和文件系统操作支持,让 AI 助手为软件开发任务提供更具针对性和上下文感知的帮助。
🚀 快速开始
这个 MCP 服务器设计用于与 Model Context Protocol 兼容的 AI 助手一起使用。以下是集成步骤:
-
安装 VSCode 扩展:
- 打开 VSCode。
- 进入扩展视图(按
Ctrl+Shift+X或从菜单选择“View” > “Extensions”)。 - 搜索并安装“VSCode Context MCP”扩展。
-
运行 MCP 服务器:
- 安装完成后,打开终端(按
Ctrl+Alt+T)。 - 输入命令:
npm start mcp-server - 按回车开始服务。
- 安装完成后,打开终端(按
-
配置 AI 助手:
- 在你的 AI 助手设置中,指定 MCP 服务器的地址和端口。
- 确保 API 密钥或认证令牌已正确配置以访问服务。
✨ 主要特性
VSCode 上下文访问
- 获取当前项目路径
- 检索活动文件内容和元数据
- 列出打开的编辑器标签页
- 访问诊断问题(警告/错误)
- 获取终端输出
- 访问工作区附加的文件
文件系统操作
- 读取/写入文件
- 基于行的文件修改
- 创建目录
- 列出目录内容
- 生成目录树
- 搜索文件
- 获取文件元数据
- 移动/重命名文件
命令执行
- 捕获输出执行shell命令
- 控执行环境
⚠️ 安全警告
⚠️ 重要提示
小心你让这个服务器运行的内容!在 Claude Desktop 应用中,使用
Approve Once(而不是Allow for This Chat)以便你可以审查每条命令,并使用Deny如果你不信任该命令。权限由正在运行服务器的用户决定。此工具尚未实现全面的安全措施,因此请谨慎对待。
📚 详细文档
工具参考
以下是可用命令及其描述:
get_vscode_context:获取当前 VSCode 上下文信息。list_directory:列出指定目录中的文件和子目录。create_directory:创建新的目录结构。search_files:搜索匹配特定模式的文件。edit_file:基于行进行文件修改。write_file:创建或覆盖文件内容。move_file:移动或重命名文件和目录。directory_tree:获取目录的递归结构信息。
发展计划
- 支持多个 VSCode 项目
- 文件写入/编辑的确认/撤销功能
- 用户界面重新设计
贡献
欢迎贡献!请随意提交 Pull Request。
📄 许可证
本项目在 MIT 许可证下开源,详情请参阅 LICENSE 文件。
Scan to join WeChat group