Filesystem MCP

🚀 ファイルシステムサーバ説明

このプロジェクトは、Model Context Protocol（MCP）プロトコルに準拠したファイルシステムとのインタラクションを行うサーバです。主な機能は、AIエージェントに対して、安全で効率的かつ機能豊富なインターフェースを提供し、様々なファイル操作タスクを実行することです。

✨ 主な機能

ファイルの閲覧とチェック

• list_files と stat_items：ファイルとディレクトリをリストアップ（再帰的なリストアップも可能）し、複数のファイルの状態情報を取得します。
• get_file_info：単一のファイルの詳細情報（メタデータや内容の要約を含む）を取得します。

内容の読み書き

• read_content、write_content、append_content：複数のファイルの読み取り、書き込み、追加機能を実現し、親ディレクトリを自動的に作成します。
• search_files：キーワードまたは正規表現を使用して複数のファイル内を検索し、一致する結果を返します。

精密な編集と検索

• edit_file と replace_content：複数のファイルの内容を精密に変更（挿入、置換、削除操作を含む）し、コードのインデントを保持し、変更ログを出力します。
• search_files と replace_in_files：複数のファイルにまたがるテキストの検索と置換を実現し、コンテキスト情報を提供して目的の内容をより正確に特定します。

ディレクトリ管理

• create_directories：1つまたは複数のディレクトリを作成し、親ディレクトリを再帰的に作成することもできます。
• delete_items と move_items：ファイルやディレクトリの安全な削除、移動、および名前の変更操作を実行します。

権限管理

• chmod_items と chown_items：ファイルやディレクトリのPOSIX権限と所有者情報を一括で変更し、権限設定を正確に行います。

🔍 利点

1. 高い安全性 すべての操作は指定されたルートディレクトリ内に制限され、越界アクセスを防止します。

2. 優れた効率性 複数のファイルを一括で処理することができ、AIエージェントとの通信オーバーヘッドを大幅に削減します。

3. 高い信頼性 各操作は詳細な実行結果とエラーレポートを返し、デバッグや問題の解決を容易にします。

4. 機能の充実性 ファイルのライフサイクルをカバーする豊富な操作インターフェースを提供し、さまざまなシーンのニーズを満たします。

📚 設計理念

• 安全第一：すべての操作を指定されたルートディレクトリ内に厳格に制限します。
• 効率優先：直接的なAPI呼び出しにより、リソースの消費と遅延を削減します。
• シンプルで明確：明確で一貫したMCPプロトコルインターフェースを提供し、統合と使用を容易にします。
• 安定して信頼性が高い：各機能は全面的なテストを経ており、Zodモードを使用して入力パラメータを厳密に検証します。

💼 使用シーン

1. コードリポジトリ管理

   • 自動化されたファイルのチェックと修復操作を実行します。

2. コンテンツ生成ツール

   • 効率的な複数ファイルの読み書き機能を提供し、コンテンツ生成プロセスを加速します。

3. データ処理プラットフォーム

   • 複雑なデータ処理ロジック（ファイルのフィルタリング、変換、アーカイブなど）を実現します。

🛠️ 開発情報

プロジェクトアーキテクチャ

このサーバはモジュール化設計を採用しています。

• コア管理層：権限の検証と操作の合法性チェックを担当します。
• ファイル操作層：具体的なファイルシステムの呼び出しをラッピングします。
• ネットワーク通信層：HTTPまたはWebSocketベースのインターフェースを提供します。
• ログと監視層：操作ログを記録し、リアルタイム監視機能を提供します。

📦 インストール

1. 依存関係をインストールします。

pip install zstandard python-multipart uvicorn[server,cli]

2. 設定ファイルを初期化します。

cp config.example.yaml config.yaml && nano config.yaml

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

uvicorn server:app --host 0.0.0.0 --port 8000

💻 使用例

ディレクトリ内容の一覧表示

GET /api/list HTTP/1.1
Host: localhost:8000
Authorization: Bearer <your-token>
Directory: ./examples

ファイル内容の書き込み

POST /api/write HTTP/1.1
Host: localhost:8000
Authorization: Bearer <your-token>
Content-Type: multipart/form-data

-- boundary
filename=example.txt
content=hello world
-- boundary--

プロジェクトのデモビデオ

• リンク: サーバの動作デモ
• 時間: 5分

❓ よくある質問

1. 大きなファイルはどのように処理しますか？

   • チャンク単位のアップロードとダウンロード機能をサポートし、大きなファイルを効率的に処理します。

2. 安全性はどのように保証しますか？

   • すべての操作は事前に設定されたルートディレクトリ内に制限され、ユーザーの権限を厳密に検証します。

3. 機能を拡張するにはどうすればいいですか？

   • プラグインメカニズムを通じて新しい機能を柔軟に追加でき、コアコードの簡潔性を維持します。

🌟 将来の展望

• WebSocketベースの長時間接続をサポートする開発を計画し、リアルタイムのファイル操作の効率を向上させます。
• バージョン管理機能を追加することを検討し、ファイルの変更履歴を管理しやすくします。
• 主流のコードリポジトリ（Gitなど）との統合の可能性を探ります。

👥 開発チーム

メンテナー: John Doe
貢献者: Alice Smith, Bob Johnson

⚠️ 重要提示

このドキュメントの一部の情報（リンクやサンプルなど）はまだ完全に準備ができていません。関連する内容は順次補完されます。