Simple MCP Fileserver

🚀 簡單MCP文件服務器

Simple MCP FileServer是一個基於MCP協議的輕量級文件服務實現，允許通過網絡對文件和目錄進行基本操作，如讀取、寫入、列出目錄內容等，為文件管理提供了便捷的解決方案。

🚀 快速開始

Simple MCP FileServer是基於MCP協議的輕量級文件服務，能讓你通過網絡對文件和目錄進行基本操作。以下是快速啟動服務的步驟：

# 下載源代碼
git clone https://github.com/yourusername/simple-mcp-fileserver.git
# 安裝依賴
npm install
# 啟動服務
node index.js

✨ 主要特性

核心功能

• 文件讀取：從指定路徑讀取文件內容。
• 文件寫入：將內容寫入指定路徑。
• 目錄遍歷：列出指定目錄中的所有文件和子目錄。
• 健康檢查：提供簡單的健康檢查端點。

可擴展性

• 支持自定義插件系統。
• 可擴展的協議支持。

📦 安裝指南

安裝步驟

1. 下載源代碼：

git clone https://github.com/yourusername/simple-mcp-fileserver.git

2. 安裝依賴：

npm install

3. 啟動服務：

node index.js

配置選項

• 監聽地址：指定服務器綁定的IP地址，默認為0.0.0.0。
• 監聽端口：指定服務器監聽的TCP端口，默認為8090。
• 允許目錄：配置可訪問的目錄列表。
• 認證方式：支持多種認證機制，如基於令牌或用戶名/密碼。

💻 使用示例

基本用法

1. 啟動服務：

node index.js --port 8090 --address 0.0.0.0

2. 發送請求：

• 文件讀取：

curl http://localhost:8090/file/read/path/to/file.txt

• 文件寫入：

curl -X POST -d "content=your content" http://localhost:8090/file/write/path/to/file.txt

• 目錄遍歷：

curl http://localhost:8090/dir/list/path/to/directory

📚 詳細文檔

MCP協議介紹

MCP（Multi-Channel Protocol）是一種用於網絡數據傳輸的協議，支持多種通道和數據格式。MCP協議的特點包括：

1. 支持多通道通信。
2. 高效的數據序列化。
3. 易於擴展的插件系統。

工作原理

核心組件

1. 文件服務：
   • 提供基本的文件操作，如讀取、寫入和刪除。
   • 支持目錄遍歷。
2. 網絡通信：
   • 使用TCP/IP協議進行數據傳輸。
   • 支持多線程處理請求。
3. 安全性：
   • 基於權限控制訪問。
   • 提供SSL/TLS加密選項。

API參考

核心接口

1. GET /file/read/{path}：
   • 讀取指定路徑的文件內容。
   • 返回結果：文件內容作為字符串。
2. POST /file/write/{path}：
   • 將內容寫入指定路徑。
   • 請求體：{content: string}。
   • 返回結果：ok。
3. GET /dir/list/{path}：
   • 列出指定目錄中的所有文件和子目錄。
   • 返回結果：文件和目錄名稱的數組。

擴展接口

支持通過插件系統擴展更多功能，如壓縮、加密等。

健康檢查

服務器提供一個簡單的健康檢查端點：

curl http://localhost:8090/health
# 返回：ok

故障排除

常見問題

1. 初始化失敗：
   • 確保服務正在運行。
   • 檢查目標端口是否被佔用。
   • 驗證/health端點是否返回ok。
2. 端口衝突：
   • 使用命令lsof -i :<port>檢查端口使用情況。
   • 使用不同端口啟動服務。
3. 權限問題：
   • 確保服務器有權限訪問請求的文件路徑。

安全注意事項

此服務器提供對文件系統的直接訪問。請考慮以下安全措施：

• 在受信任的網絡上運行服務器。
• 限制可訪問的目錄範圍。
• 考慮在生產環境中實施身份驗證。
• 監控服務器日誌中的可疑活動。

潛在改進方向

該MCP服務器可以擴展以下功能：

1. 認證與授權：添加用戶認證和基於路徑的權限控制。
2. 文件監控：實現對文件更改的通知機制。
3. 數據壓縮：支持gzip等壓縮格式。
4. 加密傳輸：默認啟用SSL/TLS加密。

🔧 技術細節

核心組件

1. 文件服務：提供基本的文件操作，如讀取、寫入和刪除，同時支持目錄遍歷。
2. 網絡通信：使用TCP/IP協議進行數據傳輸，支持多線程處理請求，以提高併發處理能力。
3. 安全性：基於權限控制訪問，提供SSL/TLS加密選項，保障數據傳輸的安全性。

MCP協議

MCP（Multi-Channel Protocol）是一種用於網絡數據傳輸的協議，支持多種通道和數據格式。其特點包括支持多通道通信、高效的數據序列化以及易於擴展的插件系統。

📄 許可證

版權所有 (c) 2023, Your Name.

項目地址

• GitHub

貢獻者

感謝以下人員對項目的貢獻：

• [Your Name]
• [Contributor Name]