MCP File Navigator

🚀 MCP 文件服務器

MCP 文件服務器是一個基於 Node.js 的模塊化文件管理工具，它支持多種文件操作功能。通過配置不同的服務，用戶可以擴展其功能，實現如壓縮、加密或其他自定義需求。

🚀 快速開始

安裝依賴

npm install express fs-extra shelljs

啟動服務器

node mcp_server.js

默認端口為 3000。如需更改端口，請在啟動時指定：

PORT=8080 node mcp_server.js

✨ 主要特性

核心功能

• 設置基礎目錄
  • 參數：path（新的基礎目錄路徑，必須是絕對路徑）
  • 返回：確認信息
• 獲取當前基礎目錄
  • 參數：無
  • 返回：當前基礎目錄路徑
• 列出文件
  • 參數：directory（可選，要列出的目錄路徑，默認為根目錄）
  • 返回：文件和目錄的格式化列表
• 讀取文件內容
  • 參數：path（要讀取的文件路徑）
  • 返回：文件內容
• 寫入文件
  • 參數：path（要寫入的文件路徑）、content（要寫入的內容）
  • 返回：確認信息
• 刪除文件或目錄
  • 參數：path（要刪除的文件或目錄路徑）
  • 返回：確認信息

擴展功能

• Git 命令執行：在基礎目錄中執行 Git 命令。
  • 參數：command（要執行的 Git 命令，不帶 git 前綴）、shell（可選，執行命令所用的 Shell，如 cmd、powershell、bash）
  • 返回：命令輸出（標準輸出和錯誤輸出）

📚 詳細文檔

日誌與調試

檢查位於 log/mcp_debug.log 的日誌文件，可獲取服務器操作的詳細信息及可能發生的錯誤。

問題排查

常見問題及解決辦法如下：

1. 路徑訪問錯誤：確保 BASE_DIRECTORY 設置為進程可訪問的位置。
2. 連接被拒絕：確認服務器正在運行。
3. 工具未找到：驗證配置文件中的工具名稱與服務器定義的完全一致。
4. 端口衝突：運行多個 MCP 服務時，確保使用不同的端口。
5. 無效基礎目錄：在從聊天中設置基礎目錄時，請提供絕對路徑（非相對路徑）。
6. Git 命令錯誤：確保 Git 已安裝且基礎目錄是一個有效的 Git 倉庫。

貢獻指南

如何貢獻

• 提交問題報告：提交詳細的錯誤報告，附上覆現步驟。
• 功能請求：提出新功能或改進建議。
• 文檔改進：幫助完善或擴展現有文檔。
• 代碼貢獻：提交修復錯誤或實現新功能的拉取請求。

開發流程

1. 分支創建：在自己的倉庫中為每個特性或修正創建獨立分支。
2. 遵循編碼標準：保持代碼風格的一致性。
3. 編寫測試：為新增功能或修復添加相應的測試用例。
4. 更新文檔：修改相關文檔，反映所做的更改。
5. 提交拉取請求：提交一個清晰描述變更的拉取請求。

拉取請求指南

• 每個 PR 集中處理單一特性或修正。
• 包括對變更的詳細說明和理由。
• 確保所有測試通過。
• 使用英文作為主要語言，除非另有規定。

文檔歷史

• 版本 1.0：初始發佈（2023年10月）
• 版本 1.1：添加 Git 命令支持及日誌功能（2023年11月）

如需進一步瞭解或尋求幫助，請參考項目文檔或聯繫維護團隊。