Filesystem MCP Server (@shtse8filesystem Mcp)

🚀 文件系統 MCP 服務器 (@sylphlab/filesystem-mcp)

這是一個遵守 Model [Context Protocol](https://github.com/Modelคณะกรรม parchain/model-context-protocol) 的文件系統工具包。它藉助標準的輸入輸出協議，為 AI 代理或其他需要高效文件操作的應用，提供對文件系統的強大控制。

🚀 快速開始

此服務器為您的 AI 代理提供了強大的文件系統工具箱，可通過 npm 進行安裝。

通過 npm 安裝

npm install @sylphlab/filesystem-mcp

使用示例

import { createClient } from '@sylphlab/filesystem-mcp';

const client = createClient();

// 示例：列出當前目錄下的文件和子目錄
client.listFiles({
  path: '.',
  recursive: false,
  showHidden: true,
}).then((result) => {
  console.log('操作結果:', result);
});

✨ 主要特性

• 文件和目錄管理：創建、刪除、移動和複製文件及目錄。
• 內容讀寫：讀取、寫入和追加文件內容，支持遞歸創建父目錄。
• 權限控制：更改文件和目錄的 POSIX 權限和所有權。
• 搜索與替換：在多個文件中進行精確編輯、查找和替換。
• 列表與統計：列出文件和目錄（可選遞歸），獲取詳細狀態信息。

所有工具均支持批處理操作，每個操作都會返回詳細的執行結果報告。

🔧 技術細節

核心優勢

1. 高效性：通過批處理減少通信開銷，降低 AI 代理的調用次數。
2. 安全性：嚴格限制在項目根目錄內操作，防止越界訪問。
3. 可靠性：提供詳細的錯誤報告和成功狀態信息。
4. 易用性：遵循統一的 API 接口，簡化集成過程。

📚 詳細文檔

• 完整文檔：包括詳細的 API 參考和示例，請訪問 文檔網站。
• 協議規範：遵循 Model Context Protocol，確保與 AI 代理的兼容性。

🛠️ 開發步驟

1. 克隆倉庫：

   git clone https://github.com/sylphlab/filesystem-mcp.git
   

2. 安裝依賴：

   cd filesystem-mcp && pnpm install
   

3. 構建項目：

   pnpm run build
   

4. 監控開發（可選）：

   pnpm run dev
   

🚀 發佈說明

此倉庫使用 GitHub Actions 自動化發佈流程：

• npm 發佈：在將版本標籤 (v*.*.*) 推送到 main 分支時，自動發佈到 npm。
• Docker 鏡像構建與推送：同步進行 Docker 鏡像的構建和推送至 Docker Hub。

需要在 GitHub 倉庫設置中配置以下秘密：

• NPM_TOKEN
• DOCKERHUB_USERNAME
• DOCKERHUB_TOKEN

🤝 貢獻指南

歡迎貢獻！請通過 GitHub 倉庫 提交問題或拉取請求。

📄 許可證

本項目以 MIT License 發佈。