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 表格

环境变量

| 属性 | 详情 | |------|------| | SENTRY_DSN | Sentry 数据源名称，用于错误跟踪（可选） |

依赖项

| 属性 | 详情 | |------|------| | @modelcontextprotocol/sdk | MCP SDK 包 | | zod | 模式验证 | | @sentry/node | 错误跟踪和性能监控 |