Filesystem MCP Server

🚀 文件系統協議服務器

這是一個基於 Model Context Protocol (MCP) 的文件系統協議服務器，它能讓 AI 模型藉助上下文協議與文件系統進行交互。該服務器為 AI 模型操作文件系統提供了便捷且安全的途徑，極大提升了 AI 模型在文件管理方面的能力。

🚀 快速開始

項目使用 TypeScript 實現，提供了強類型支持。你可以按照以下步驟來運行這個文件系統協議服務器：

1. 使用 npm 進行依賴管理：

npm install

2. 編譯源代碼：

tsc --build

3. 運行服務器：

node dist/server.js

✨ 主要特性

• 文件操作：可對文件和目錄進行讀取、寫入、更新、刪除等操作。
• 目錄管理：支持創建、列出、移動、複製目錄。
• 狀態管理：能夠維護會話級狀態，例如默認路徑。
• 日誌記錄與錯誤處理：集成了日誌記錄和錯誤處理機制。
• 速率限制：具備防止濫用的保護措施。

📦 安裝指南

依賴安裝

使用 npm 安裝項目依賴：

npm install

代碼編譯

使用 TypeScript 編譯器編譯源代碼：

tsc --build

💻 使用示例

基礎用法

以下是一個讀取文件的工具實現示例：

//.ReadFile.ts
export async function read_file(request: ReadFileRequest): Promise<ReadFileResponse> {
    const { path } = request;
    try {
        const content = await fs.promises.readFile(path, 'utf8');
        return { success: true, content };
    } catch (error) {
        return { success: false, error: error.message };
    }
}

📚 詳細文檔

文件系統結構圖

+-filesystem-mcp-server/
| +-dist/                 # 編譯後的 JavaScript 輸出 (運行 npm run build 後生成)
| +-logs/                # 日誌文件（運行時創建）
| +-node_modules/        # 項目依賴項
| +-src/                 # TypeScript 源代碼
|   +-config/             # 配置加載（index.ts）
|   +-mcp-server/         # 核心 MCP 服務器邏輯
|   | +-server.ts          # 服務器初始化和工具註冊
|   | +-state.ts           # 會話狀態管理（例如默認路徑）
|   | +-tools/             # 各個工具的實現（每個工具一個子文件夾）
|   | | +-readFile/
|   | | | +-index.ts
|   | | | +-readFileLogic.ts
|   | | | +-registration.ts
|   | | \-...              # 其他工具（writeFile, updateFile 等）
|   +-types-global/       # 共享 TypeScript 類型和接口
|   | +-errors.ts          # 自定義錯誤類和代碼
|   | +-mcp.ts             # MCP 相關類型
|   | \-tool.ts            # 工具定義類型
|   +-utils/              # 可重用的實用工具模塊
|   | +-errorHandler.ts
|   | +-idGenerator.ts
|   | +-index.ts
|   | +-logger.ts
|   | +-rateLimiter.ts
|   | +-requestContext.ts
|   | \-sanitization.ts
|   \-index.ts            # 應用程序入口點
| +-clinerules           # Cheatsheet 對於 LLM 代碼助手
| +-gitignore
| +-LICENSE
| +-package.json
| +-package-lock.json
| +-README.md             # 本文件
| \-tsconfig.json         # TypeScript 編譯器選項

工具列表

基本文件操作工具

目錄管理工具

項目結構

核心組件

• Server.ts：作為服務器主程序，負責處理連接和消息路由。
• State.ts：維護會話級狀態，包含默認路徑等信息。
• Tools/：存放各個文件操作工具的具體實現。

🔧 技術細節

工具實現示例

//.ReadFile.ts
export async function read_file(request: ReadFileRequest): Promise<ReadFileResponse> {
    const { path } = request;
    try {
        const content = await fs.promises.readFile(path, 'utf8');
        return { success: true, content };
    } catch (error) {
        return { success: false, error: error.message };
    }
}

📄 許可證

項目遵循 MIT 許可證，具體條款參見 LICENSE 文件。

👥 構建團隊

• 作者：[你的名字]
• 貢獻者：[你的名字]
• 維護者：[你的名字]

如需進一步瞭解 Model Context Protocol，請訪問 官方文檔。