Trash Cleaner MCP Server

🚀 ゴミファイルクリーナーMCPサービス

このサービスは、macOS用に設計されたMCP（メッセージ処理プログラム）サービスで、ゴミファイルのスキャン、分析、およびクリーニングを行います。ゴミファイルのクリーニング、タスクスケジューリング、監査ログ管理など、豊富な機能モジュールを提供します。

🚀 クイックスタート

1. リポジトリをクローンします：

   git clone <repository-url>
   cd trash-cleaner-mcp-server
   

2. 依存関係をインストールします：

   bun install
   

3. サービスを起動します：

   bun start
   

✨ 主な機能

• クロスプラットフォーム対応：主にmacOSを対象としていますが、一部の機能はWindowsとLinuxでも利用できます。
• スマートスキャン：様々なタイプのゴミファイルを自動的に識別し、分類することができます。
• 選択的クリーニング：ユーザーは特定のファイルまたはディレクトリを選択してクリーニング操作を行うことができます。
• タスクスケジューリング：強力なタスクスケジューリング機能を提供し、cron式を使用してクリーニングタスクを自動化することができます。
• 監査ログ：システム操作のログ情報を詳細に記録し、後の追跡と分析に役立ちます。

📦 インストール

1. リポジトリをクローンします：

   git clone <repository-url>
   cd trash-cleaner-mcp-server
   

2. 依存関係をインストールします：

   bun install
   

3. サービスを起動します：

   bun start
   

💻 使用例

基本的な使用法

# リポジトリをクローン
git clone <repository-url>
cd trash-cleaner-mcp-server

# 依存関係をインストール
bun install

# サービスを起動
bun start

高度な使用法

# 特定のディレクトリをクリーニングするタスクを作成
# ここではTrashCleaner_DeletePathツールを使用し、特定のパスを削除するタスクを作成する例
# タスク名、cron式、ターゲットツール、パラメータなどを設定
# 具体的なコマンドはサービスのAPIに依存するため、ここでは概略を示す
# 例えば、APIを通じてタスクを作成する場合
# （このコマンドは仮想的なもので、実際のAPIに合わせて調整する必要があります）
curl -X POST -H "Content-Type: application/json" -d '{
  "name": "CleanSpecificDirectory",
  "cronExpression": "0 0 * * *",
  "targetTool": "TrashCleaner_DeletePath",
  "parameters": {
    "path": "/path/to/directory"
  },
  "enabled": true
}' http://localhost:3000/tasks

📚 ドキュメント

使用ツール

macOS専用ツール

1. TrashCleaner_CleanAppCaches
   アプリケーションのキャッシュファイルをクリーニングします。

2. TrashCleaner_DeletePath
   指定されたファイルまたはディレクトリを削除します。削除操作は二度確認が必要で、特に高リスクのパスについては追加の検証が行われます。

3. TrashCleaner_ViewAuditLog
   最新の監査ログ内容を表示します。デフォルトでは最近の100件の記録が表示されます。

クロスプラットフォームツール

4. TrashCleaner_GetSystemType
   オペレーティングシステムの識別子を返します（例：'darwin' はmacOS、'win32' はWindows、'linux' はLinuxを表します）。

5. TrashCleaner_CheckPathExists
   指定されたパスが存在するかどうかを確認し、そのタイプがファイルかディレクトリかを判断します。

6. TrashCleaner_DeletePath
   指定されたファイルまたはディレクトリを削除します。削除操作は二度確認が必要で、特に高リスクのパスについては追加の検証が行われます。

監査ツール

• viewAuditLog：アプリケーションの主要なログファイル（combined.log）の最近の記録を表示します。
• clearAuditLog：主要なアプリケーションログファイル（combined.log）を削除します。操作には確認が必要です。

タスクスケジューラ (TrashCleaner_Scheduler ツール)

タスクの作成

新しいタスクを作成するには、name と cronExpression を指定する必要があり、ターゲットツールの名前またはクエリー記述を提供する必要があります。タスクのパラメータと有効状態を設定することもできます。

タスクの一覧表示

すべての設定済みタスクとその状態情報を表示します。

タスクの詳細取得

タスクIDを使用して、タスク名、実行計画、ターゲットツールなどの詳細情報を取得します。

タスクの更新

既存のタスクの情報を更新します。タスク名、実行計画、ターゲットツール（正確な名前または曖昧な記述）、パラメータ、有効状態などを更新することができます。

タスクの有効/無効化

タスクの実行状態を柔軟に制御するために、タスクの起動と停止を行うことができます。

タスクの削除

指定されたタスクを永久に削除します。

タスクの手動実行

タスクを手動で即時実行し、テストや緊急対応に便利です。

技術スタック

設定情報

• ログ設定は src/utils/logger.ts にあります。
• タスクスケジューリングの定義はユーザーディレクトリの ~/.trash-cleaner/schedules.json に保存されます。

開発ガイド

(ここには具体的な開発規則とプロセスの説明が追加されます)