Filesys

🚀 ファイルシステム MCP プロジェクトドキュメント

この filesys は、Python と mcp ライブラリを基に構築された軽量級の MCP サーバーです。事前に設定されたディレクトリからファイルの内容とメタデータを安全に公開します。FastMCP を利用して以下の機能を提供します。

• 指定したディレクトリ内のすべてのファイルをリストアップします。
• 特定のファイルの内容とメタデータを読み取ります。

新機能： 現在、Anthropic の Claude AI が統合され、ユーザーは自然言語での対話を通じてファイルシステムとやり取りできます。Claude Tools を使用して、定義された MCP リソースに安全にアクセスできます。

このプロジェクトは、パスの検証とディレクトリトラバーサル攻撃の防止により、安全なファイルアクセスを保証します。

🚀 クイックスタート

このプロジェクトを始めるには、以下の手順に従ってください。

✨ 主な機能

• Claude と対話して safe_folder 内のファイルをリストアップし、読み取ることができます。

🔧 技術詳細

核心機能は以下の部分に分かれています。

• リソース：
  src/resources.py では、2 つの関数がファイル操作を担当しています。

  • list_files(): 指定したディレクトリをスキャンし、すべてのファイルのリストを返します。
  • read_file(): ファイル名に基づいてファイルの内容を読み取り、その内容を返します。

• サーバー：
  run.py では、簡単な MCP サーバーが定義されています。起動後、ポートを監視し、クライアントからのリクエストを処理します。サーバーはリソースモジュール内の関数を呼び出してリクエストに応答します。

• Claude ツールクライアント：
  claude_tool_client.py では、MCP サーバーとやり取りするツール関数が定義されています。これらの関数は、サーバーの機能をテストするために使用でき、Claude がリクエストを送信するためのインターフェースを提供します。

• テスト：
  tests/ ディレクトリにユニットテストファイル（例：tests/test_resources.py）がある場合、以下のコマンドを実行してテストを実行できます。

python -m unittest discover tests

📦 インストール

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

git clone [リポジトリアドレス]

2. 仮想環境を作成し、依存関係をインストールします。

python -m venv venv
source venv/bin/activate  # Windows では `venv\Scripts\activate` を使用
pip install mcp

3. API キーを設定します。

• config/config.json ファイルを編集し、サーバーの設定（例：ポート）を設定します。
• .env.local ファイルを作成し、Anthropic の API キーを追加します。

💻 使用例

基本的な使用法

1. MCP サーバーを起動します。

python run.py

2. Claude と対話します。

python interact_with_claude.py

3. 直接 MCP リクエストを送信することもできます（オプション）。

• ファイルをリストアップする： files://list リクエストを送信します。
• ファイルを読み取る： files://read/{filename} リクエストを送信します（{filename} を実際のファイル名に置き換えてください）。

📚 ドキュメント

貢献方法

このプロジェクトへの貢献を歓迎します。以下の手順に従ってください。

1. リポジトリを Fork します。
2. 新しいブランチを作成して、機能追加や修正を行います。
3. 変更をコミットし、詳細なコミットメッセージを追加します。
4. ブランチをプッシュし、GitHub で Pull Request を開きます。

その他の注意事項

• 必要に応じて、設定ファイル (config/config.json と .env.local) をカスタマイズしてください。

⚠️ 重要提示

interact_with_claude.py スクリプトは、run.py サーバーが別のプロセスで実行されている必要があります。

• このプロジェクトは、基本的なセキュリティ対策を実装しており、設定されたディレクトリへのアクセスを制限し、ディレクトリトラバーサル攻撃を防止します。
• 新機能を追加したり、変更を加えた場合は、このドキュメントを更新してください。