filesystem

filesystem

site icon
2025.03.17 4
TypeScript文件管理文件管理
mcp-filesystem 是一个基于 Model Context Protocol (MCP) 的文件系统服务,使用 mcp-framework 构建。它提供了文件管理和工具开发的能力,支持自定义工具的创建和集成。
View on GitHub

Overview

基本能力

产品定位

mcp-filesystem 是一个文件系统服务,专注于文件管理和工具开发,适用于需要文件操作和自定义工具集成的场景。

核心功能

  1. 文件系统管理:提供文件操作和管理能力。
  2. 工具开发:支持自定义工具的创建和集成。
  3. MCP 协议支持:基于 MCP 协议,与其他 MCP 服务兼容。
  4. npm 发布:支持将工具发布到 npm,方便共享和使用。

适用场景

  1. 文件操作:需要文件读写、管理等操作的场景。
  2. 工具集成:需要自定义工具并集成到现有系统的场景。
  3. 开发环境:适用于开发环境中的文件管理和工具开发。

工具列表

  1. ExampleTool:示例工具,展示如何创建自定义工具。
  2. data-processor:数据处理工具。
  3. api-client:API 客户端工具。
  4. file-handler:文件处理工具。

常见问题解答

  1. 如何添加新工具? 使用命令 mcp add tool my-tool 添加新工具。
  2. 如何发布到 npm? 更新 package.json 后,运行 npm publish 发布。
  3. 如何与 Claude Desktop 集成? 修改 Claude Desktop 的配置文件,添加 mcp-filesystem 的配置。

使用教程

使用依赖

# Install dependencies
npm install

安装教程

# Build the project
npm run build

调试方式

# Test your CLI locally
npm link
filesystem

许可证

None