Bsmi021 MCP Filesystem Server

🚀 文件系統 MCP 服務器

文件系統 MCP 服務器是一個基於 MCP 協議的標準工具接口，它具備文件系統操作、分析和管理等功能，為文件系統相關操作提供了便捷、高效的解決方案。

🚀 快速開始

文件系統 MCP 服務器基於 MCP 協議實現了文件系統操作、分析和管理功能。以下是快速部署該服務器的步驟：

# 克隆倉庫
git clone <repository-url>
cd filesystem-server

# 安裝依賴項
npm install

# 構建服務器
npm run build

# 配置 MCP 設置（cline_mcp_settings.json）
{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args": ["path/to/filesystem-server/build/index.js"]
    }
  }
}

✨ 主要特性

• 分層架構：採用分層設計，包括服務器層、工具註冊表、操作層和文件系統接口，各層分工明確，便於維護和擴展。
• 豐富的工具接口：提供了目錄操作、文件操作等多種工具接口，支持列出目錄內容、讀取和寫入文件等常見操作。
• 錯誤處理機制：定義了詳細的錯誤碼和信息，方便開發者快速定位和解決問題。
• 開發友好：支持監視模式、代碼檢查和類型檢查，有助於提高開發效率和代碼質量。

📦 安裝指南

克隆倉庫

git clone <repository-url>
cd filesystem-server

安裝依賴項

npm install

構建服務器

npm run build

配置 MCP 設置

在 cline_mcp_settings.json 中進行如下配置：

{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args": ["path/to/filesystem-server/build/index.js"]
    }
  }
}

💻 使用示例

目錄操作

list_directory

列出目錄內容及其元數據。

interface ListDirectoryParams {
  /** 要列出的目錄路徑 */
  path: string;
}

interface ListDirectoryResult {
  /** 目錄中的文件和子目錄列表 */
  entries: Array<{
    /** 文件或子目錄的名稱 */
    name: string;
    /** 文件類型（'file' 或 'directory'） */
    type: string;
    /** 修改時間 */
    modifiedTime: Date;
  }>;
}

const result = await filesystem.listFiles('/path/to/dir');
// 結果結構如上所示

文件操作

read_file

讀取文件內容。

interface ReadFileParams {
  /** 要讀取的文件路徑 */
  path: string;
}

interface ReadFileResult {
  /** 文件內容（二進制緩衝區） */
  content: Buffer;
}

const content = await filesystem.readFile('/path/to/file.txt');
// content 包含文件數據

write_file

寫入文件內容。

interface WriteFileParams {
  /** 要寫的文件路徑 */
  path: string;
  /** 文件內容 */
  content: Buffer | string;
}

interface WriteFileResult {
  /** 寫入的字節數 */
  bytesWritten: number;
}

const result = await filesystem.writeFile('/path/to/file.txt', '寫入的內容');
// 返回寫入的字節數

📚 詳細文檔

結構

該服務器基於 MCP SDK 構建，並劃分為不同的層次：

graph TD
    A[ MCP 服務器層 ] --> B[ 工具註冊表 ]
    B --> C[ 操作層 ]
    C --> D[ 文件系統操作 ]
    C --> E[ 分析操作 ]
    C --> F[ 流操作 ]

組件

• 服務器層：處理 MCP 協議通信和工具調度。
• 工具註冊表：管理工具的註冊和執行。
• 操作層：實現核心功能。
• 文件系統接口：提供安全的文件系統訪問。

錯誤處理

錯誤碼和信息

• 400 Bad Request：無效請求參數。
• 401 Unauthorized：權限不足，無法執行操作。
• 404 Not Found：指定文件或目錄不存在。
• 500 Internal Server Error：服務器內部錯誤。

開發模式

監視模式

npm run watch

代碼質量

檢查代碼

npm run lint

類型檢查

npm run type-check

🤝 貢獻指南

1. 叉倉庫：將項目倉庫 fork 到自己的 GitHub 賬戶下。
2. 創建功能分支：在自己的倉庫中創建新的功能分支。
3. 編寫測試：為新功能編寫相應的測試用例。
4. 確保測試通過：運行所有測試，確保新功能不會引入新的問題。
5. 提交拉取請求：將自己的修改提交到原倉庫，等待審核和合並。

📄 許可證

本項目採用 MIT 許可證。