使用说明

项目简介

Trash Cleaner MCP Server 是一款基于 Model Context Protocol (MCP) 构建的桌面后端服务,旨在为 LLM 客户端提供系统垃圾清理和维护能力。它通过注册一系列工具 (Tools) 和资源 (Resources),使得 LLM 应用能够调用服务器的功能,例如扫描垃圾文件、清理缓存、管理 VS Code 扩展、进行文件系统操作以及执行定时任务等。该服务器主要针对 macOS 系统进行了优化,但也提供部分跨平台工具。

主要功能点

  • 智能垃圾扫描: 能够识别多种类型的垃圾文件,如缓存、日志、临时文件、应用残留等。
  • 选择性清理: 提供针对特定区域(如应用缓存、临时文件、VS Code 扩展)的清理工具。
  • 文件系统工具: 包含目录分析、文件查找、大小计算、删除等文件系统实用工具。
  • 系统信息: 提供基本的操作系统类型检测。
  • 审计日志: 记录所有操作,方便追踪和审计。
  • 定时任务: 支持灵活的任务调度,可以自动化执行清理和其他维护任务。
  • 资源管理: 内置垃圾清理规则配置资源,支持自定义清理策略。

安装步骤

  1. 克隆仓库

    git clone https://github.com/dabing1022/trash-cleaner-mcp-server
    cd trash-cleaner-mcp-server
  2. 安装依赖

    确保你已经安装了 Bun,然后运行:

    bun install

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到 Trash Cleaner MCP Server。请注意,以下配置信息不是用于修改服务器本身的行为,而是告诉 MCP 客户端如何启动和连接服务器。

{
  "serverName": "Trash Cleaner MCP Server",
  "command": "bunx",
  "args": [
    "@childhoodandy/trash-cleaner-mcp-server"
  ],
  "説明": "上述配置指示 MCP 客户端使用 bunx 命令来运行 @childhoodandy/trash-cleaner-mcp-server 包,从而启动 Trash Cleaner MCP Server。客户端通过标准输入输出 (stdio) 与服务器进行通信。"
}

参数说明:

  • '"serverName"': MCP 服务器的名称,用于客户端识别,可以自定义。
  • '"command"': 启动 MCP 服务器的可执行命令,这里使用 'bunx',它会查找并执行 npm 包。
  • '"args"': 传递给 'bunx' 命令的参数,'[@childhoodandy/trash-cleaner-mcp-server]' 指定要执行的 npm 包名称。

注意: 如果该服务发布到 npm 后,你可以直接使用 'bunx @childhoodandy/trash-cleaner-mcp-server' 命令启动,无需手动构建。如果需要本地开发或运行,则需要先按照 "运行服务器" 步骤操作。

基本使用方法

  1. 启动服务器

    在仓库根目录下,运行以下命令启动 Trash Cleaner MCP Server:

    bun start

    服务器默认通过标准输入输出 (stdio) 协议与客户端通信。

  2. 配置 MCP 客户端

    在你的 MCP 客户端应用中,按照客户端的要求配置服务器连接信息,使用上面提供的 JSON 配置。客户端会根据配置启动服务器进程并建立连接。

  3. 调用工具 (Tools)

    客户端连接成功后,可以列出服务器提供的工具,并调用相应的工具来执行垃圾清理、文件操作等任务。例如,调用 'TrashCleaner_CleanAppCaches' 工具清理应用缓存,或调用 'TrashCleaner_ScanFullSystem' 工具进行全盘扫描。

  4. 管理定时任务 (Scheduled Tasks)

    通过客户端调用 'TrashCleaner_Scheduler_' 开头的工具,可以创建、查询、更新、删除和管理定时任务,实现自动化系统维护。

重要提示:

  • 部分清理工具(特别是 macOS 清理工具)是为 macOS 系统设计的,在其他系统上使用可能无效或产生未知行为。请仔细阅读工具描述和警告信息。
  • 删除文件是危险操作,请务必谨慎使用 'Fs_DeletePath' 等删除工具,并仔细确认操作,避免误删重要文件。
  • 清空垃圾桶、深度清理等操作具有一定风险,请在了解其作用和潜在影响后谨慎使用。

信息

分类

桌面与硬件