MCP Filesystem

🚀 MCP 文件系統協議服務器

MCP 文件系統協議服務器是一個能為每個工作目錄提供文件資源，並及時發送文件更改通知的模型上下文協議 (MCP) 服務器。它極大地提升了文件管理與監控的效率，為開發者帶來便利。

🚀 快速開始

狀態

⚠️ 預 Beta 質量 ⚠️

“在我的機器上運行正常”。歡迎提出問題 ❤️

✨ 主要特性

• 資源創建：為工作區中的每個文件創建一個 MCP 資源。
• .gitignore 支持：嚴格遵循 .gitignore 規則，精準過濾文件。
• 更改通知：即時檢測文件的更改、添加和刪除操作，讓您及時掌握文件動態。
• MIME 類型識別與編碼處理：準確識別文件類型，並能處理多種文本編碼。

📦 安裝指南

安裝 Go

按照 https://golang.org/doc/install 的說明進行操作。

獲取或更新此服務器

go install github.com/isaacphi/mcp-filesystem@latest

客戶端配置

將以下內容添加到客戶端配置文件（位於 ~/Library/Application Support/Claude/claude_desktop_config.json 對於 Claude Desktop）：

{
  "mcpServers": {
    "filesystem": {
      "command": "mcp-filesystem",
      "args": ["--workspace", "/path/to/your/repository"]
    }
  }
}

請將 /path/to/your/repository 替換為項目的絕對路徑。

💻 使用示例

基礎用法

您的客戶端能夠訪問和引用工作區中的所有非忽略文件作為 MCP 資源。每個文件都會註冊為具有適當 MIME 類型檢測的獨立資源。

客戶端要求

您的客戶端需要支持以下 MCP 特性：

• 資源列表：具備列出並訪問服務器暴露的所有資源的能力。
• 更改通知：支持接收 notifications/resources/list_changed 事件。
• 資源內容訪問：能夠請求和呈現資源內容及其適當 MIME 類型。

📚 詳細文檔

關於

該項目使用了以下技術：

• mark3labs/mcp-go 提供 MCP 通信
• fsnotify 監測文件系統事件
• go-gitignore 解析 .gitignore 文件

開發

克隆倉庫

git clone https://github.com/isaacphi/mcp-filesystem.git
cd mcp-filesystem

安裝依賴項

go mod download

構建

go build

配置客戶端以使用本地構建版本

{
  "mcpServers": {
    "filesystem": {
      "command": "/full/path/to/your/mcp-filesystem/mcp-filesystem",
      "args": ["--workspace", "/path/to/repository"],
      "env": {
        "DEBUG": "1"
      }
    }
  }
}

反饋

請提交詳細的問題，包含所有相關信息。設置 DEBUG 環境變量以啟用詳細日誌記錄：

"env": {
  "DEBUG": "1"
}

計劃中的功能

• [x] 工作區中每個文件的資源
• [x] .gitignore 支持
• [x] 更改通知
• [ ] 標準化 MCP 協議以支持更多客戶端（Claude Desktop）
• [ ] 可配置的支持行號
• [ ] 資源更新訂閱
• [ ] 額外的忽略模式（超出 .gitignore 之外）
• [ ] 延遲通知以處理高頻率文件更改
• [ ] info, create, edit 和 delete 工具