Bsmi021 MCP File Operations Server

🚀 文件操作 MCP 服務器

一個提供增強文件操作功能的模型上下文協議（MCP）服務器，支持流式傳輸、補丁處理和變更跟蹤，能有效提升文件操作的效率與安全性。

🚀 快速開始

此 MCP 服務器提供了增強的文件操作功能，支持流式傳輸、補丁處理和變更跟蹤等。以下將為你介紹其安裝和使用方法。

✨ 主要特性

• 基本文件操作：支持複製、讀取、寫入、移動和刪除文件等常規操作。
• 目錄操作：可創建、移除和複製目錄，方便進行目錄管理。
• 文件監控：能監視文件和目錄的變更，及時掌握文件狀態。
• 變更跟蹤：可跟蹤和查詢文件操作歷史記錄，便於追溯操作。
• 流式支持：能高效處理大文件，提供高效分塊傳輸。
• 資源訪問：可通過 MCP 資源訪問文件和目錄。
• 進度報告：長操作可即時進行進度更新。
• 速率限制：防止過多請求，保護服務器穩定運行。
• 增強安全性：進行路徑驗證和輸入清理，保障操作安全。
• robust 錯誤處理：具備全面的錯誤處理和報告機制。
• 類型安全：擁有完整的 TypeScript 支持，帶有嚴格的類型檢查。

📦 安裝指南

通過史密斯ery 安裝

1. 訪問 https://smithery.ai/
2. 登錄並導航至“工作區”。
3. 點擊“從代碼庫創建新工作區”。
4. 在 URL 欄輸入倉庫地址：git+ssh://github.com/bsmi021/mcp-file-operations-server.git
5. 完成工作區設置後，點擊“創建”。

手動安裝

1. 克隆此倉庫：

git clone git@github.com:bsmi021/mcp-file-operations-server.git
cd mcp-file-operations-server

2. 安裝依賴項：

npm install

3. 啟動服務器：

node src/index.js

💻 使用示例

功能概述

• 文件操作：支持複製、移動、讀取和寫入文件。
• 目錄管理：可創建、刪除和遍歷目錄結構。
• 變更跟蹤：能記錄和檢索文件變更歷史。
• 流式傳輸：處理大文件時提供高效分塊傳輸。

基礎用法

創建新文件

POST /operations/create-file
Content-Type: application/json

{
  "path": "example.txt",
  "content": "Hello, World!"
}

複製文件

POST /operations/copy-file
Content-Type: application/json

{
  "sourcePath": "example.txt",
  "destinationPath": "copy_example.txt"
}

讀取文件內容

GET /operations/read-file?path=example.txt

📚 詳細文檔

項目結構

1. 核心模塊

   • file-system：處理文件和目錄的基本操作。
   • operations：包含各種文件操作工具。
   • resources：定義可訪問的資源接口。

2. 日誌系統

// 配置日誌記錄器
const logger = require('mcp-logger');

// 記錄不同級別的日誌信息
logger.debug("調試信息");
logger.info("一般信息");
logger.warn("警告信息");
logger.error("錯誤信息");

依賴管理

項目使用 npm 進行依賴管理，主要依賴包括：

• express：Web 服務器框架。
• mcp-core：MCP 協議核心庫。
• fs-extra：增強的文件系統操作。

錯誤處理

標準錯誤代碼

1. InvalidRequest：請求格式或參數無效
2. MethodNotFound：請求的工具或資源不存在
3. InvalidParams：參數驗證失敗（如路徑無效）
4. InternalError：服務器內部錯誤

自定義錯誤類型

• 文件操作失敗
• 速率限制超出
• 路徑驗證錯誤
• 資源訪問錯誤

每個錯誤都包含詳細的上下文信息，包括錯誤代碼、具體消息和相關元數據。

配置選項

通過 config.json 定義服務器行為：

{
  "rateLimits": {
    "requestsPerMinute": 100,
    "windowMs": 60000
  },
  "progressReporting": {
    "updateInterval": 1000,
    "detailLevel": "high"
  }
}

貢獻指南

1. 參與項目：查看 Issues 找到適合的任務。
2. 提交代碼：
   • 創建功能分支：git checkout -b feature/amazing-feature
   • 提交變更：git commit -m '添加 amazing 功能'
   • 推送到遠程倉庫：git push origin feature/amazing-feature
3. 創建拉取請求：前往 Pull Requests 提交您的貢獻。

📄 許可證

本項目遵循 MIT 許可證，具體內容請參閱 LICENSE 文件。