MCP File Tool

🚀 MCP 文件服務器

MCP 文件服務器基於 Model Context Protocol (MCP) 實現，藉助標準化接口為文件系統操作提供支持，能讓 AI 模型通過標準化 API 對本地文件系統執行文件操作。

🚀 快速開始

MCP 文件服務器使 AI 模型能夠通過標準化 API 對本地文件系統執行文件操作。它使用 Model Context Protocol SDK 構建，並提供了讀取、創建和列出文件的工具。

✨ 主要特性

• 創建文件：在指定路徑創建新文件並寫入內容
• 讀取文件：讀取現有文件的內容
• 列出目錄內容：列出指定路徑下的文件和目錄及其詳細信息
• 性能監控：內置 Sentry 集成，用於錯誤跟蹤和性能監控

📦 安裝指南

npm install

💻 使用示例

基礎用法

啟動 MCP 文件服務器：

node src/index.js

服務器通過 stdin/stdout 使用 MCP 協議進行通信。

高級用法

通過 MCP 協議調用可用工具的示例：

createfile

{
  "name": "createfile",
  "params": {
    "filePath": "example/test.txt",
    "content": "Hello, world!"
  }
}

在指定路徑創建新文件並寫入內容。

readfile

{
  "name": "readfile",
  "params": {
    "filePath": "example/test.txt"
  }
}

讀取指定路徑下文件的內容。

listfiles

{
  "name": "listfiles",
  "params": {
    "path": "example"
  }
}

列出指定路徑下的文件和目錄。

📚 詳細文檔

可用工具

createfile

在指定路徑創建新文件並寫入內容。

參數：

• filePath：文件應創建的路徑
• content：要寫入文件的內容

返回：

• 成功消息，包含文件路徑和大小信息

readfile

讀取指定路徑下文件的內容。

參數：

• filePath：要讀取的文件路徑

返回：

• 文件內容

listfiles

列出指定路徑下的文件和目錄。

參數：

• path：要列出內容的目錄路徑

返回：

• 包含文件名、大小和類型的 Markdown 表格

環境變量

依賴項