MCP File Server

MCP File Server

site icon
2025.02.26 0
JavaScript文件管理文件管理
MCP File Server 是一个基于 Model Context Protocol (MCP) 的服务实现,提供通过标准化接口进行文件系统操作的能力。该服务允许AI模型通过标准化的API对本地文件系统进行文件操作,包括创建、读取和列出文件等功能。
View on GitHub

Overview

基本能力

产品定位

MCP File Server 是一个文件管理服务,提供标准化的文件操作接口,适用于需要文件系统操作的AI模型和应用。

核心功能

  • 创建文件:在指定路径创建新文件并写入内容
  • 读取文件:读取指定路径文件的内容
  • 列出目录内容:列出指定目录下的文件和目录,并提供详细信息
  • 性能监控:内置 Sentry 集成,用于错误跟踪和性能监控

适用场景

  • AI模型需要访问或操作本地文件系统
  • 需要标准化接口进行文件管理的应用
  • 需要错误跟踪和性能监控的文件操作服务

工具列表

  1. createfile:创建新文件
  2. 参数:filePath(文件路径)、content(文件内容)
  3. 返回:包含文件路径和大小信息的成功消息
  4. readfile:读取文件内容
  5. 参数:filePath(文件路径)
  6. 返回:文件内容
  7. listfiles:列出目录内容
  8. 参数:path(目录路径)
  9. 返回:包含文件名、大小和类型的Markdown表格

常见问题解答

  • 如何启用错误跟踪?通过设置 SENTRY_DSN 环境变量启用 Sentry 错误跟踪。

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

npm install

启动服务

node src/index.js

调试方式

服务通过 stdin/stdout 使用 MCP 协议进行通信。可以通过发送 JSON 格式的命令来测试工具功能,例如:

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

许可证

None