Vsc MCP

🚀 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 請求檢查代碼格式和類型定義。
• 返回結構化信息，如錯誤、警告和位置。