Filesystem MCP

🚀 文件系統 MCP 🌐

文件系統 MCP 是一個基於 Node.js 的模型上下文協議（MCP）服務器，為 AI 代理（如 Cline 和 Claude）提供安全、相對的文件系統訪問，保障交互安全且操作便捷。

🚀 快速開始

歡迎來到 文件系統 MCP 倉庫！這個項目提供了一個基於 Node.js 的模型上下文協議（MCP）服務器，旨在為 AI 代理（如 Cline 和 Claude）提供安全、相對的文件系統訪問。

✨ 主要特性

• 安全訪問：確保 AI 代理以安全方式與文件系統交互。
• 相對路徑支持：簡化無需絕對路徑的文件訪問過程。
• AI 代理支持：特別設計用於與 Cline 和 Claude 配合使用。
• Node.js 構建：利用 Node.js 的強大功能進行高效的服務器端操作。
• TypeScript 支持：提供類型安全和更好的開發者體驗。

📦 安裝指南

要開始使用文件系統 MCP 服務器，請按照以下步驟操作：

克隆倉庫

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

安裝依賴項

確保已安裝 Node.js。然後運行：

npm install

下載最新版本

你可以從 這裡 下載最新版本。下載相應文件後執行。

💻 使用示例

基礎用法

要啟動服務器，請運行以下命令：

npm start

示例配置

你可以通過修改 config.json 文件來配置服務器。以下是一個示例配置：

{
  "port": 3000,
  "secure": true,
  "allowedAgents": ["Cline", "Claude"]
}

發送請求

服務器運行後，你可以通過以下命令發送請求以訪問文件系統：

curl -X GET http://localhost:3000/files/path/to/your/file

錯誤處理

服務器針對不同錯誤返回相應的 HTTP 狀態碼。例如：

• 404 Not Found：資源未找到。
• 500 Internal Server Error：服務器內部錯誤。

📚 詳細文檔

API 文檔

以下是文件系統 MCP 服務器的 API 文檔：

獲取文件內容

URL: /files/:filename
方法: GET

示例響應

成功時：

{
  "content": "...",
  "status": "success"
}

失敗時：

{
  "message": "...",
  "status": "error"
}

創建新文件

URL: /files
方法: POST
請求體:
{
  "filename": "string",
  "content": "string"
}

🤝 貢獻指南

要為項目做貢獻，請按照以下步驟操作：

Fork 倉庫

在 GitHub 上 Fork 本倉庫。

創建功能分支

git checkout -b feature/your-feature-name main

提交更改

提交你的更改並遵循 commit message 格式規範。

推送至遠程倉庫

git push origin feature/your-feature-name

創建 Pull Request

在 GitHub 上為您的分支創建 Pull Request。

📄 許可證

本項目採用 MIT 許可證。請參考 LICENSE 文件獲取詳細信息。

📬 聯繫方式

作者：[你的名字]
郵箱：[你的郵箱]
GitHub 倉庫：https://github.com/Tabeeh/filesystem-mcp

感謝您使用文件系統 MCP！更多更新請訪問 Releases 頁面 。