Editor MCP

🚀 文本編輯器 MCP 用戶指南

文本編輯器 MCP 藉助 FastMCP 構建了功能強大的文本編輯服務器，支持 AI 助手以結構化方式編輯代碼及其他文本文件。相較於傳統命令行工具，MCP 具備文件完整性驗證、使用限制和交互式確認流程等高級功能。

🚀 快速開始

MCP 支持通過環境變量進行配置，以下是一些關鍵的環境變量：

最大選擇行數

max_select_lines 用於限制在 overwrite 操作中可選中的最大行數，默認值為 50。示例配置如下：

export max_select_lines=100

啟用統計收集

DUCKDB_USAGE_STATS 啟用後，MCP 會將使用統計信息收集到 DuckDB 數據庫。

禁用 ID 驗證

將 DISABLE_ID_VERIFICATION 設置為 true 可禁用文件內容的完整性驗證。示例如下：

export DISABLE_ID_VERIFICATION=true

✨ 主要特性

• 結構化編輯：允許 AI 助手以結構化方式編輯代碼和文本文件。
• 高級功能：提供文件完整性驗證、使用限制和交互式確認流程等傳統命令行工具所沒有的功能。
• 環境變量配置：支持通過環境變量對 MCP 進行靈活配置。
• 使用統計收集：可收集使用統計信息以用於改進服務質量和分析系統性能。

📚 詳細文檔

服務器實現細節

初始化

主類 TextEditorServer 初始化時會接收一個 FastMCP 實例，命名為 "text - editor"。

文件完整性驗證系統

該系統採用 SHA - 256 生成文件內容或選中行範圍的唯一標識符。例如，針對特定行的修改操作，ID 會包含行範圍前綴（如："L10 - 15 - [哈希值]"），確保編輯操作應用於預期內容。

註冊的工具

服務器通過 FastMCP 註冊了以下主要工具：

• set_file：用於設置當前要編輯的文件路徑。
• skim：讀取整個文件內容並返回行號到行文本的字典。
• read：根據指定的行範圍讀取內容，返回結構化的字典。
• select：選擇後續 overwrite 操作中涉及的特定行（最多 50 行）。
• overwrite：接收新的行列表，並生成 diff 格式的預覽以顯示將要進行的更改。
• confirm：應用之前 overwrite 工具準備的更改。
• cancel：放棄 overwrite 工具中的 pending 改變。
• delete_file：刪除當前文件。
• new_file：創建新文件。
• find_line：查找包含特定文本的行。
• find_function：在 Python 和 JavaScript/JSX 文件中查找函數定義。

系統提示的最佳實踐

為優化 AI 助手的行為，建議使用系統提示（system prompt）。示例如下：

mcp_server.set_system_prompt("作為經驗豐富的軟件工程師，你應當以嚴格和安全的方式執行編輯操作。")

這樣能確保助手在進行文件修改時更加謹慎，並遵循最佳編程實踐。

使用統計信息

數據收集

MCP 具備使用 DuckDB 進行數據收集的功能，用於記錄用戶對服務器的使用情況。

記錄的信息

包括但不限於：

• 用戶 ID
• 操作類型（讀取、寫入等）
• 操作時間戳
• 文件大小變化
• 錯誤日誌

存儲位置

統計數據存儲在當前工作目錄下的 mcp_usage.db 數據庫文件中。

隱私考慮

所有收集的數據均為匿名化處理，僅用於改進服務質量和分析系統性能。

故障排除

常見問題

• 問題：無法連接到 MCP 服務器
  • 解決方法：檢查服務器是否在運行，確認網絡配置正確。
• 問題：收到 ID 驗證失敗的錯誤
  • 解決方法：要麼啟用 ID 驗證（默認啟用），要麼禁用該功能。

靈感來源

此項目受開源社區啟發，特別是 FastMCP 和類似工具的成功經驗。