🚀 VSC-MCP 工具

VSC-MCP 工具借助 MCP (模型上下文协议) 调用语言服务器协议（LSP）功能，让 AI 代理能通过标准化的 MCP 工具，对 TypeScript/JavaScript 代码进行程序化分析与编辑。

🚀 快速开始

VSC-MCP 工具可帮助你借助 MCP 工具调用 LSP 功能，对 TypeScript/JavaScript 代码进行分析和编辑。以下是使用前的准备步骤。

✨ 主要特性

• 多模式支持：支持单文件模式或项目模式（检测 tsconfig.json 文件）。
• 语言无关操作：通过 LSP API 实现语言无关的代码操作。
• 高度兼容：完全兼容 模型上下文协议 (MCP) SDK。

📦 安装指南

先决条件

• Bun（用于包管理和构建）
• Node.js（用于运行服务器）

设置

1. 克隆仓库。
2. 安装依赖项：

   bun install
   

🔧 技术细节

安全功能

路径限制

VSC-MCP 工具具备防止文件操作访问未经授权目录的安全特性：

• ALLOWED_DIRECTORIES：一个环境变量，指定允许进行文件操作的逗号分隔目录列表。

  示例：

  ALLOWED_DIRECTORIES=/home/user/projects,/tmp/workspace
  

• 如果未设置此环境变量，默认情况下只允许当前工作目录的操作。

• 所有文件操作（读取、写入、编辑）都会检查目标路径是否在允许的目录内。

• 尝试访问允许目录之外的文件将导致“访问被拒绝”错误。

该功能有助于防止未经授权访问系统上的敏感文件和目录。

工作原理

• 以标准输入输出模式启动 TypeScript 语言服务器。
• 发送 LSP 的 initialize 和 didOpen 通知。
• 使用 workspace/symbol 和 textDocument/documentSymbol 请求查找符号。
• 在无法找到符号时，回退到 textDocument/implementation 进行额外的符号发现。
• 直接对文件应用编辑操作使用 applyWorkspaceEdit 工具。
• 将操作结果返回给调用方。

💻 使用示例

可用工具

目前有以下工具可供使用：

editSymbol

通过 LSP 以名称和类型编辑文件中的符号（函数、类、方法等）。

• 支持的符号类型包括：函数、方法、类、接口、变量、常量、属性、字段。
• 使用 LSP 的 workspace/symbol 和 textDocument/documentSymbol 请求查找符号。
• 返回结构化信息，如文件路径和位置。

readSymbol

通过 LSP 以名称和类型读取文件中的符号（函数、类、方法等）。

• 支持的符号类型包括：函数、方法、类、接口、变量、常量、属性、字段。
• 使用 LSP 的 workspace/symbol 和 textDocument/documentSymbol 请求查找符号。
• 返回结构化信息，如文件路径和位置。

findReferences

通过 LSP 找到文件中符号（函数、类等）的所有引用。

• 支持的符号类型包括：函数、方法、类、接口、变量、常量、属性、字段。
• 使用 LSP 的 textDocument/references 请求查找所有符号引用。
• 返回引用列表，包含文件路径和位置。
• 帮助进行代码分析、重构和理解代码使用情况。

getDefinition

通过 LSP 获取符号（函数、类等）的定义。

• 支持的符号类型包括：函数、方法、类、接口、变量、常量、属性、字段。
• 使用 LSP 的 textDocument/definition 请求获取符号定义。
• 返回结构化信息，如文件路径和位置。

getDocumentation

通过 LSP 获取符号（函数、类等）的文档注释。

• 支持的符号类型包括：函数、方法、类、接口、变量、常量、属性、字段。
• 使用 LSP 的 textDocument/hover 和 textDocument/documentSymbol 请求获取文档信息。
• 返回结构化信息，如文档内容和位置。

getCodeIssues

通过 LSP 检查代码问题。

• 使用 LSP 的 textDocument/formatting 和 textDocument/typeDefinition 请求检查代码格式和类型定义。
• 返回结构化信息，如错误、警告和位置。